Get Report

curl -X GET 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query/{task_id}?skip=0&size=50' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

{
  "data": {
    "stats": {
      "rows": [
        {
          "rows": [
            {
              "date": "2021-11-01",
              "total": {
                "totalCost": {
                  "value": 0
                },
                "totalRevenue": {
                  "value": 10
                },
                "totalUniqueUsers": {
                  "value": 1,
                  "isMasked": true
                }
              },
              "values": [
                {
                  "value": 1,
                  "isMasked": false
                },
                {
                  "value": 2,
                  "isMasked": false
                },
                {
                  "value": 3,
                  "isMasked": false
                },
                {
                  "value": 4,
                  "isMasked": false
                }
              ]
            }
          ],
          "total": {
            "rows": [
              {
                "value": 1,
                "isMasked": false
              },
              {
                "value": 2,
                "isMasked": false
              },
              {
                "value": 3,
                "isMasked": false
              },
              {
                "value": 4,
                "isMasked": false
              }
            ],
            "totalCost": {
              "value": 0
            },
            "totalRevenue": {
              "value": 10.45
            },
            "totalUniqueUsers": {
              "value": 1,
              "isMasked": false
            }
          },
          "metadata": [
            "<groupBy>"
          ]
        }
      ]
    },
    "status": "SUCCESS",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d",
    "endedAt": "2022-01-17T19:10:00.286939+09:00",
    "hasNext": false,
    "metadata": {
      "totalCount": 48
    }
  },
  "notification": [
    {
      "code": "AGG_DATA_MASKING_BY_FACEBOOK",
      "type": "info",
      "message": "some data is masked by facebook privacy policy."
    }
  ]
}

The status of an asynchronous request can be checked with task.status in the API request result.

`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.

Response Notification

If certain was was removed, refer to the reason in notification[0].code.

`SAN_PERIOD_LIMIT`	The data has been removed according to Self-Attribution Networks’ compliance policies. For example, removed data from 175 days ago that was attributed to Meta.

Try API Request

GET

https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query/{task_id}

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)

string

required

The task_id returned by the result of the ‘Request Report’ API.

Query Params

number

The number of rows to be skipped.Get results except the first N number of rows.The default is 0.

number

A limit on the number of rows to be returned.Get results of the next N rows after those skipped by the skip option.The default is 50.e.g.) ?skip=200&size=100In this case, it returns the rows 201 to 300. (skips first 200 rows, gets next 100 rows)

curl -X GET 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query/{task_id}?skip=0&size=50' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200

404

{
  "data": {
    "stats": {
      "rows": [
        {
          "rows": [
            {
              "date": "2021-11-01",
              "total": {
                "totalCost": {
                  "value": 0
                },
                "totalRevenue": {
                  "value": 10
                },
                "totalUniqueUsers": {
                  "value": 1,
                  "isMasked": true
                }
              },
              "values": [
                {
                  "value": 1,
                  "isMasked": false
                },
                {
                  "value": 2,
                  "isMasked": false
                },
                {
                  "value": 3,
                  "isMasked": false
                },
                {
                  "value": 4,
                  "isMasked": false
                }
              ]
            }
          ],
          "total": {
            "rows": [
              {
                "value": 1,
                "isMasked": false
              },
              {
                "value": 2,
                "isMasked": false
              },
              {
                "value": 3,
                "isMasked": false
              },
              {
                "value": 4,
                "isMasked": false
              }
            ],
            "totalCost": {
              "value": 0
            },
            "totalRevenue": {
              "value": 10.45
            },
            "totalUniqueUsers": {
              "value": 1,
              "isMasked": false
            }
          },
          "metadata": [
            "<groupBy>"
          ]
        }
      ]
    },
    "status": "SUCCESS",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d",
    "endedAt": "2022-01-17T19:10:00.286939+09:00",
    "hasNext": false,
    "metadata": {
      "totalCount": 48
    }
  },
  "notification": [
    {
      "code": "AGG_DATA_MASKING_BY_FACEBOOK",
      "type": "info",
      "message": "some data is masked by facebook privacy policy."
    }
  ]
}

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

Response Notification

Try API Request

Request

Headers

Path Params

Query Params

Response

200

404

Response Notification

Try API Request

​Request

​Headers

​Path Params

​Query Params

​Response

​200

​404

Request

Headers

Path Params

Query Params

Response

200

404