Jetfuel API Integration

3 min readSep 26, 2019

Jetfuel Basic Reporting API

Updated April 2021

This Reporting API can be used to get aggregated campaign data in JSON or CSV format.

Request Format

Report requests should be sent via HTTP GET requests to a following base URL:

https://plugco.in/reporting_api/v1/report

Authorization

Bearer Tokens are required to access the api. Each Advertiser is assigned a bearer token, which can be used to access their data. This token must be included on every request as a header. A 401 is returned if a bearer token is not set correctly or not valid.
Header Info — Authorization: Bearer <token>
You can get your token from your Jetfuel account manager.

Required Parameters

start_date is the start date of the report. Accepts date in ‘YYYY-MM-DD’ format. For example, 2019–09–01.
end_date is the end date of the report. Accepts date in ‘YYYY-MM-DD’ format. For example, 2019–09–07. Reports are return inclusive of the end date.
columns is a comma separated list of columns for the report. See the allowed columns below. For example: date, media, clicks, installs, cost
format is the format you want the result in. Either csv or json.

Optional Parameters

limit parameter would set the a limit on the number of rows returned. For example, 500
offset parameter would set the offset to begin fetching rows at. For example, 2
having parameter allows complex filtering on the following values: installs, clicks, cost. NOTE This will slow down the response and increase the likelihood of timeouts.

Allowed Advertiser Columns

date — date of reporting data
campaign_name — The name of the Campaign in the Jetfuel System. Usually this is your app name
campaign —the jetfuel campaign_id assigned for this app
publisher— the jetfuel publisher_id associated with these clicks / installs (these refer to a specific influencer account — not neccesarily a specific snapchat/ig account)
media — The jetfuel media_id associated with these clicks / installs.
media _url— A public URL which can be used to view the media associated with this media object.
advertiser_campaign_name — The custom iOS/Android campaign name set by the advertiser. Note that platform MUST be included in the request if asking for this column, otherwise the value would be indeterminate.
app_id — For iOS this is the App ID associated with the given app (ie. 835599320 for Tiktok). For Android apps this is the Bundle ID (ie. com.zhiliaoapp.musically for tiktok). Note that platform MUST be included in the request if asking for this column, otherwise the value would be indeterminate.
country — two letter country code
currency — The currency of the cost data (currently always USD)
platform — android, ios
clicks — number of clicks
installs — number of installs
cost — cost billed to the advertiser
conversion_rate — number of conversions / number of clicks
average_cpa — average cost per conversion
average_cpc — average cost per click

Sorting Columns

Sorting reports works very similar to the way filters work.

For example, to sort a report by campaign_name, add the following url parameter: sort=campaign_name:ASC

The accepted values are ‘ASC’ for ascending or ‘DESC’ for descending. All sorts are lexicographical sort.

Time Zone

All data in the reporting API is in UTC (Coordinated Universal Time).

Example Requests

Example 1:

https://plugco.in/reporting_api/v1/report?start_date=2019-09-01&end_date=2019-09-07&columns=date,campaign,clicks,installs,cost&format=json

Example 2:

https://plugco.in/reporting_api/v1/report?start_date=2019-09-01&end_date=2019-09-01&columns=date,campaign_name,campaign,publisher,media,media_url,advertiser_campaign_name,app_id,country,currency,platform,clicks,installs,cost,conversion_rate,average_cpa,average_cpc&format=json&sort=installs:DESC&limit=100&offset=0

Example 3:

https://plugco.in/reporting_api/v1/report?start_date=2019-09-01&end_date=2019-09-07&columns=campaign_name,campaign,publisher,clicks,installs,cost&format=json&sort=installs:DESC&having=cost>10

Returned Format

Success: {“data”: [], “success”: 1, “count”:10}

Failure: {“message”: “No start_date included in this request.”, “success”: 0}

Rate Limit

We rate limit requests to 15 requests per 10 seconds. We will return a 429 response in this case.

Questions or Comments?

Please email jj@jetfuel.it and I’ll take a look at it right away!