Request Report

curl -X POST 'https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/query' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{
  "from": "2022-11-04",
  "groupBys": [
    "event_source",
    "event_type",
    "event_category"
  ],
  "metrics": [
    "app_events"
  ],
  "filters": [
    {
      "dimension": "channel",
      "filterType": "IN",
      "values": [
        "App"
      ]
    }
  ],
  "sorts": [
    {
      "fieldName": "event_type",
      "isAscending": true
    }
  ]
}'

{
  "task": {
    "status": "RUNNING",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d"
  }
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "traceId": "1-000000-000000000000000"
}

Actuals Report provides customization features for the metrics and data you intend to analyze. Using the various data fields provided by Airbridge, you can customize the report in all forms such as subdividing data into specific criteria, adding metrics on granular criteria, or applying filters. Request Actuals Report. rate limit: There is no specific limit for normal usage. However, if excessive requests that may threaten service stability are detected, a temporary 429 Too Many Requests response may be returned.

POST

https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/query

Request

Headers

string

You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.

string

Represents the media type of the resource. Defaults to application/json.

string

The key value to use for API requests. Instructions for getting API keys are in “how to generate API Keys”.

Path Params

string

required

Airbridge App Name. (Unique ID)

Body Params

string

required

The start date of the report data to request.

The date must be in the format ‘YYYY-MM-DD’
This date must correspond with the timezone set in the Airbridge app.
Future dates are not permitted.

string

The end date of the report data to request.

The date must be in the format ‘YYYY-MM-DD’
This date must correspond with the timezone set in the Airbridge app.
The system only accepts dates up the current date. The time period available for querying is up to 400 days.

string[]

required

Report “Group By”.‘Group By’ is necessary when seeking a more detailed view in reports. The complete list of GroupBys that can be selected in the Actuals report can be checked through the Get Metadata (GroupBy) APIThe maximum threshold is 10.

string[]

required

Report “Metrics”.Various ad performance data can be examined through metrics. The complete list of metrics that can be selected in the Actuals report can be checked through the Get Metadata (Metric) API.The maximum threshold is 20.

object[]

required

The filter for providing ‘group by’ items.

Show child attributes

string

required

The groupBys to filter by.Only values defined within groupBys can be used.

enum

required

The operator to apply to the filter.

Value	Description
`IN`	In. In Actuals reports, this corresponds to equals (is, =).
`NOT IN`	Not in. In Actuals reports, this corresponds to is not, ≠.
`LIKE`	Contains. ∋
`NOT LIKE`	Does not contain. ∌
`EXIST`	Value exists.
`NOT EXIST`	Value does not exist.

string[]

The value to apply to the filter.

object[]

required

Sort report data by ‘Group By’ or ‘Metric’.

Show child attributes

string

required

Values within ‘groupBys’ or ‘metrics’ serve as criteria for sorting.

boolean

Sort by ascending (A-Z) or not. (Default: true)

object

Show child attributes

enum

curl -X POST 'https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/query' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{
  "from": "2022-11-04",
  "groupBys": [
    "event_source",
    "event_type",
    "event_category"
  ],
  "metrics": [
    "app_events"
  ],
  "filters": [
    {
      "dimension": "channel",
      "filterType": "IN",
      "values": [
        "App"
      ]
    }
  ],
  "sorts": [
    {
      "fieldName": "event_type",
      "isAscending": true
    }
  ]
}'

Response

200

task.status


`PENDING`	Data aggregation is in preparation.
`RUNNING`	Data is being aggregated.
`SUCCESS`	The aggregation is completed and returns the result.
`FAILURE`	The request has failed.
`CANCELED`	The request has been canceled.

404

{
  "task": {
    "status": "RUNNING",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d"
  }
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "traceId": "1-000000-000000000000000"
}

API Reference

Tracking Link

Server-to-Server Event

Actuals Report

Revenue Report

Active Users Report

Retention Report

Raw Data

Attribution Result

Self-Serve Data Upload

SKAdNetwork Configuration API

Request

Headers

Path Params

Body Params

Response

200

404