Get Report

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

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

{
  "task": {
    "status": "SUCCESS",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d",
    "endedAt": "2022-10-01T00:00:00+00:00"
  },
  "actuals": {
    "data": {
      "rows": [
        {
          "values": {
            "app_installs": {
              "value": 100,
              "isMasked": false,
              "viewFormat": "{value}"
            }
          },
          "groupBys": [
            "<groupBy>"
          ]
        },
        {
          "values": {
            "app_installs": {
              "value": 13,
              "isMasked": true,
              "viewFormat": "{value} +α"
            }
          },
          "groupBys": [
            "<groupBy>"
          ]
        }
      ]
    },
    "metadata": {
      "rowCount": 2
    }
  },
  "pagination": {
    "hasNext": true,
    "totalCount": 200
  },
  "notifications": []
}

Request status

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 complete and returns the result.
`FAILURE`	The request has failed.
`CANCELED`	The request has been canceled.

Response Notification

If certain data was removed or masked during aggregation (masking), refer to the the reason in notification[0].code.

`MEDIA_PARTNER_DATA_FILTERED_BY_CHANNEL`	The media partner requesting the data has not been granted the permission to view them.
`AGG_DATA_MASKING_BY_FACEBOOK`	The data has been removed according to Meta’s privacy compliance policies.
`EXCEEDED_LIMIT_ON_MAX_ROW_COUNT`	The result has exceeded the maximum data value (10,000 rows per report). It is recommended that data is extracted using Raw Data Export.
`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/v7/apps/{app_name}/actuals/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 100.e.g.) ?skip=200&size=100In this case, it returns the rows 201 to 300. (skips first 200 rows, gets next 100 rows)

string

The keywords to filter on GroupBy in the results.

boolean

Determines whether to include format information used by the dashboard to represent values for the Actuals Report.If it set true, the format information (such as Meta ads masking) is included in the viewFormat field in the form of “{value}”, “{value} +α”, “Privacy Block”, etc.The default is false.

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

Response

200

The asynchronous request is being processed. The API can be polled periodically to see the results, and the status of the request can be checked with task.status.

200

Returns the result when data aggregation is complete. If status is SUCCESS, sends it to actuals with data, metadata, messages, etc.

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

{
  "task": {
    "status": "SUCCESS",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d",
    "endedAt": "2022-10-01T00:00:00+00:00"
  },
  "actuals": {
    "data": {
      "rows": [
        {
          "values": {
            "app_installs": {
              "value": 100,
              "isMasked": false,
              "viewFormat": "{value}"
            }
          },
          "groupBys": [
            "<groupBy>"
          ]
        },
        {
          "values": {
            "app_installs": {
              "value": 13,
              "isMasked": true,
              "viewFormat": "{value} +α"
            }
          },
          "groupBys": [
            "<groupBy>"
          ]
        }
      ]
    },
    "metadata": {
      "rowCount": 2
    }
  },
  "pagination": {
    "hasNext": true,
    "totalCount": 200
  },
  "notifications": []
}

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 status

Response Notification

Try API Request

Request

Headers

Path Params

Query Params

Response

200

200

Request status

Response Notification

Try API Request

​Request

​Headers

​Path Params

​Query Params

​Response

​200

​200

Request

Headers

Path Params

Query Params

Response

200

200