Request Report

The Active Users Report allows you to view key marketing performance indicators such as DAU (Daily Active Users), WAU (Weekly Active Users), and MAU (Monthly Active Users), based on the selected period. Additionally, there are no rate limits, allowing you to generate reports as needed. Request an Active Users 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.

Try API Request

POST

https://api.airbridge.io/reports/api/v4/apps/{app_name}/active-users/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

required

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 92 days.

enum

required

The analytics interval period.

Value	Description
`day`	Analyze the data by day.
`week`	Analyze the data by week. Calculated in 7 day intervals from the start date.
`month`	Analyze the data by month. Calculated the same month from the start date until the corresponding date in the subsequent month. For example, given a start date of March 10, the same month would be pretended until April 10.

string[]

required

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

object

required

Allows you to set a group by to divide the numbers for the metric you want to see.

Show child attributes

string[]

required

Report “Group By”.‘Group By’ is necessary when seeking a more detailed view in reports. This specification will allow reports to be grouped according to desired criteria. The ‘Report GroupBys’ for a comprehensive list of available options.The maximum threshold is 4.

object[]

required

The filter for providing ‘group by’ items.

Show child attributes

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

required

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

string[]

The value to apply to the filter.

curl -X POST 'https://api.airbridge.io/reports/api/v4/apps/{app_name}/active-users/query' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{
  "from": "2022-11-04",
  "to": "2022-11-11",
  "granularity": "day",
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "filters": [
    {
      "filterType": "IN",
      "field": "campaign",
      "values": [
        "App"
      ]
    }
  ]
}'

Response

200

404

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

{
  "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

Try API Request

Request

Headers

Path Params

Body Params

Response

200

404

Try API Request

​Request

​Headers

​Path Params

​Body Params

​Response

​200

​404

Request

Headers

Path Params

Body Params

Response

200

404