Report Endpoint

Report Service provides an API to get aggregated data from different sources: 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.

Before you begin

To use this endpoint, you need an Adjust API token. Use the instructions to set up and manage Adjust API authentication.

The user permissions for the API reflect the Adjust user account user permissions.

Endpoint

https://dash.adjust.com/control-center/reports-service/report

GET request

The GET method returns filtered data from the report service in JSON format.

Filters

Dimensions

Metrics

Responses

This endpoint returns the following responses:

ResponseDescriptionNotes
200SuccessReturns report information
204No contentReturned if the response object is empty
400Bad requestReturned if your request is malformed or contains unsupported parameters
401UnauthorizedReturned if your credentials are incorrect or absent
403ForbiddenReturned if you try to access information you don't have permission to view
429Too many requestsReturned if you exceed 50 simultaneous requests
503Service unavailableReturned if the server cannot be reached
504Gateway timeoutReturned if the query takes too long to return a response

Success response

{
   "rows":[
      {
         "attr_dependency":{
            
         },
         "app":"App Name",
         "partner_name":"AppLovin",
         "campaign":"Campaign Name (Campaign ID)",
         "campaign_id_network":"Campaign ID",
         "campaign_network":"Campaign Name",
         "installs":"64",
         "cost":"1000"
      }
   ],
   "totals":{
      "installs":64,
      "cost":1000
   },
   "warnings":[
      
   ]
}

Parameters

Example

curl \
--header 'Authorization: Bearer <adjust_api_token>' \
--location --request GET 'https://dash.adjust.com/control-center/reports-service/report?cost_mode=network&app_token__in={app_token1},{app_token2}&date_period=2021-05-01:2021-05-02&dimensions=app,partner_name,campaign,campaign_id_network,campaign_network&metrics=installs,network_installs,network_cost,network_ecpi' \
{
    "rows": [
        {
            "attr_dependency": {
                "campaign_id_network": "unknown",
                "partner_id": "-300",
                "partner": "Organic"
            },
            "app": "Test app",
            "partner_name": "Organic",
            "campaign": "unknown",
            "campaign_id_network": "unknown",
            "campaign_network": "unknown",
            "installs": "10",
            "network_installs": "0",
            "network_cost": "0.0",
            "network_ecpi": "0.0"
        }
    ],
    "totals": {
        "installs": 10.0,
        "network_installs": 0.0,
        "network_cost": 0.0,
        "network_ecpi": 0.0
    },
    "warnings": [],
    "pagination": null
}