API reference

Overview

Overview

The InCost API, part of AppsFlyer ROI360, lets ad networks programmatically send advertising cost data to AppsFlyer. AppsFlyer then ingests and processes the data, and makes it available to advertisers and partners via dashboards and reports. The result is advertisers get aggregate cost data that lets them understand the true ROAS impact of your network.

Prerequisites:

  • The InCost API requires prior implementation of the App list API for ad networks.
  • 90% of campaigns contain the Campaign ID.
  • The ability to send data at least 6 times per day for increased data freshness. The specific times are up to the ad network.
  • [If the ad network updates data retroactively] The ability to send data for the last 7 days every time, for increased data completion.

To integrate the API:

  1. Get the API token from your marketer to use as the bearer authorization token.
  2. Integrate the API methods as explained below.

InCost API methods

InCost API consists of 3 methods, as explained in the following table.

MethodWhat needs to be done
Get app list
  • As mentioned in prerequisites, integrate the App list API for ad networks to list the apps (app IDs) for which advertisers have enabled a cost integration with you.
  • Frequently check the list programmatically to update the list of apps for whom you send data. Remember: advertisers add apps regularly.
  • The API returns the app ID, name, timezone, and app-selected currency.
Upload cost
  • Use the API to send cost data in a JSON. Your marketer must tell you what fields to populate the JSON with.
  • InCost upload returns a job ID. You can use the job ID to check the job status.
Get job status
  • Use the API to query job status using the job ID.
  • Verify that the submitted job has an applied status.
  • If this is not the case, correct errors and resubmit.
  • A matched record score of less than 100(%) can indicate erroneous data.
  • Matching occurs when campaign attribution data, like clicks, matches campaign cost data.

Traits and limitations

TraitDescription
Date
  • Earliest date allowed: Previous 90 days relative to the current date
  • Most recent date allowed: The current date
RateAPI call-rate limited per ad network account (token):
  • 150 calls per minute
  • 1,000 calls per day
File size1 MB