Partners

⚠️

Important

All API V2 tokens generated before March 10, 2026, 19:00 UTC have been revoked. If your token was generated before this date, please regenerate it. Learn how.

Data is grouped by media source and campaign.
Data type: LTV
For details, see KB link

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Application ID

Query Params
date
required

From date (report start date)

date
required

To date (report end date)

string

Use to filter by a specific media source
Set both the category and media_source parameters as follows:

  • For Facebook set category and media_source to facebook
  • For Twitter set category and media_source to twitter
  • For all other media sources set category to standard and media_source to the name of the media source.
    Examples
  • media_source=facebook&category=facebook
  • media_source=abc_example&category=standard
string
enum
  • facebook: Get only facebook data with the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
  • organic: Get only organic data without the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
  • standard (default):
    • media_source: Get data only for the specified media_source without the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
    • media_source=facebook: Get only facebook data with the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
    • without media_source or media_source=all: Get all media_source without the following groupings: campaign_id, adset, adset_id, adgroup, adgroup_id
Allowed:
string
enum

Set this parameter as shown in the example to get view-through attribution (VTA) KPIs.

Allowed:
string
enum

Currency of revenue and cost.
Aggregate Pull API reports always use the app-specific currency.

Allowed:
string
enum

Get retargeting conversions data.
[Default] is false - user acquisition data (UA) campaigns returns.
If true, retargeting conversion returns.

Allowed:
enum
  • [Default] If the parameter is not sent, data returns using UTC.
  • Data returns using the app-specific time zone.
  • Time zone format takes into account daylight saving time.
  • The timezone value must be identical to the value in the app settings page. For example, if the timezone setting is Paris, the timezone value in the Pull API URL should be timezone=Europe/Paris.
  • Pulling data in the selected time zone is only available from the date when the timezone setting was made. Any data prior to the date of the change uses UTC as the timezone.

Choose a time zone

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/csv
application/json