We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.
CSV Report Service provides an API to get aggregated data from different sources in csv format: KPI Service deliverables, KPI Service cohorts, SKAdNetwork, and Ad Spend.
The reports endpoint enables you to combine data from many services in a single report. Request installs, revenue, ad spend, and SKAdNetwork data divided by day, app, and ad network.
The GET method returns filtered data from the report service in CSV format. The API returns columns of data for each parameter passed in the request. By default the parameter's slug is used as the column header. You can return human-readable names by passing readable_names=true in your request.
Warning:
Human-readable names can change depending on upstream requirements. Use slugs for long running reports to ensure consistency. You can use the Events endpoint to retrieve event slugs.
Filters
Filter
Type
Description
Example
dimensions*
String
Comma-separated values used to group parameters. See the dimensions table below for more information.
dimensions=app,os_name,week,campaign_id_network
metrics*
String
Comma-separated KPIs. See the metrics table below for more information.
metrics=cost,installs,ecpi_network
date_period*
String
Start and end dates for the report with 3 supported formats:
Logical dates
Absolute dates
Relative dates
Logical dates:
this_month_until_yesterday
today
yesterday
this_week
last_week
this_month
last_month
Absolute dates:
2020-12-31:2021-01-01
Relative dates:
-10d:-3d (from 10 days ago to 3 days ago)
readable_names
Boolean
Whether to return columns with their human-readable names. Defaults to false
readable_names=true
cohort_maturity
String
immature – displays current values of cumulative metrics for all cohorts, including immature cohorts.
mature – displays the values of cumulative metrics only for mature cohorts and zeros for immature cohorts.
cohort_maturity=immature
utc_offset
String
The timezone used in the report.
utc_offset=+01:00
hour__between
String
Filter results between given hours of the day.
hour__between=-10h:-0h
attribution_type
String
The type of engagement the attribution awards.
click (default)
impression
all
attribution_type=click
attribution_source
String
Whether in-app activity is assigned to the user’s install source (first) or divided among the install source and subsequent sources of reattribution (dynamic). Defaults to dynamic.
attribution_source=first
reattributed
String
Filter for reattributed users only. Reattribution is when a user who has already installed your app returns to it through a new Adjust-tracked source.
all (default)
false
true
reattributed=false
ad_revenue_mode
String
The percentage of gross ad revenue returned by the endpoint. Available options are:
Currency used for conversion of money related metrics.
currency=USD
[dimension]__in
String
Comma-separated list of values to filter dimension's values (exact match) for any dimension.
campaign__in=abc,def
[dimension]__not_in
String
Comma-separated list of values to filter dimension's values (exclude exact match) for any dimension.
campaign__not_in=abc,def
[dimension]__contains
String
Substring search in dimension's values (case insensitive) for any dimension.
campaign__contains=ios
[dimension]__exclude
String
Excluding substring search in dimension's values (case insensitive) for any dimension.
campaign__exclude=ios
[dimension]__starts_with
String
Substring search matching dimensions starting with specified prefix (case insensitive).
campaign__starts_with=ios
[dimension]__not_starts_with
String
Substring search matching dimensions not starting with specified prefix (case insensitive).
campaign__not_starts_with=ios
[dimension]__ends_with
String
Substring search matching dimensions ending with specified suffix (case insensitive).
campaign__ends_with=ios
[dimension]__not_ends_with
String
Substring search matching dimensions not ending with specified suffix (case insensitive).
campaign__not_ends_with=ios
[metric]__lt
String
"Less than" filter for metric's values any metric.
skad_installs__lt=100
[metric]__lte
String
"Less than or equal" filter for metric's values for any metric.
skad_installs__lte=100
[metric]__gt
String
"Greater than" filter for metric's values for any metric.
skad_installs__gt=100
[metric]__gte
String
"Greater than or equal" filter for metric's values for any metric.
skad_installs__gte=100
[metric]__eq
String
"Equal" filter for metric's values for any metric.
skad_installs__eq=100
metric__ne
String
"Not equal" filter for values relating to any metric.
skad_installs__ne=100
Dimensions
Dimensions allow a user to break down metrics into groups using one or several parameters. For example, the number of installs by date, country and network.
Dimension
Data type
Description
Example
hour
Date
Date value. Use format_dates=false to return the value in ISO format. YYYY-MM-DDTHH:MM:SS
2021-05-11T17:00:45
day
Date
Date value. Use format_dates=false to return the value in ISO format. YYYY-MM-DD
2021-05-11
week
Date
Date value. Use format_dates=false to return the value in ISO format. YYYY-MM-DD - YYYY-MM-DD
2021-05-09 - 2021-05-15
month
Date
Date value. Use format_dates=false to return the value in ISO format. YYYY-MM
2021-05
year
Date
Date value. Use format_dates=false to return the value in ISO format. YYYY-MM
2021
quarter
String
Date value. Use format_dates=false to return the value in ISO format. Q<quarter_number> YYYY
Q2 2021
os_name
String
Possible values:
android
bada
blackberry
ios
linux
macos
server
symbian
unknown
webos
windows
windows-phone
-
device_type
String
Possible values:
bot
console
ipod
mac
pc
phone
server
simulator
tablet
tv
unknown
-
app
String
Name of the app.
-
app_token
String
App ID in the Adjust system.
-
store_id
String
Store App ID.
com.random.app
store_type
String
Store from where the app was installed.
google_play
currency
String
Currency name.
Euro
currency_code
String
3-character value ISO 4217.
EUR
campaign
String
Tracker sub-level 1.
String value usually contains campaign name and
id.
-
campaign_network
String
Campaign name from the network.
-
campaign_id_network
String
Campaign ID from the network.
-
adgroup
String
Tracker sub-level 2.
String value usually contains adgroup name and id.
-
adgroup_network
String
Adgroup name from the network.
-
adgroup_id_network
String
Adgroup ID from the network.
-
source_network
String
Name of the source network. Optional value dependent on the network.
-
source_id_network
String
ID of the source network.
-
creative
String
Tracker sub-level 3.
String value usually contains creative name and id.
-
creative_network
String
Creative name from the network.
-
creative_id_network
String
Creative ID from the network.
-
country
String
Country name.
United States of America
country_code
String
2-character value ISO 3166.
US
region
String
Business region.
APAC
partner_name
String
Partner's name in the Adjust system.
AppLovin
partner_id
Integer
Partner’s id in the Adjust system.
34
partner
String
The unique slug of the partner.
applovin
channel
String
A combination of partner_name and network.
-
platform
String
The device operating system/platform. See list of supported platforms below.
android
Platforms
android
android-tv
bada
blackberry
facebook
fire-tv
ios
linux
macos
server
symbian
webos
windows
windows-phone
Metrics
Metrics are used to assess and compare the performance of campaigns you run and track with Adjust.
At least 1 metric is required in each API request. The most common metrics are: