• API Reference

Active Users 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 Report

POST

https://api.airbridge.io/reports/api/v4/apps/{app_name}/active-users/query

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.

Request

Headers

Accept-Language
string

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

Content-Type
string

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

Authorization
string

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

Path Params

app_name
Requiredstring

Airbridge App Name. (Unique ID)

Body Params

from
Requiredstring

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.

to
Requiredstring

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.

granularity
Requiredenum

The analytics interval period.

ENUM VALUES
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.

metrics
Requiredstring[]

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.

groupBy
Requiredobject

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

filters
Requiredobject[]

The filter for providing 'group by' items.

Request
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"]}]}'
Payload
{ "from": "2022-11-04", "to": "2022-11-11", "granularity": "day", "groupBy": { "fields": [ "channel" ] }, "filters": [ { "filterType": "IN", "field": "campaign", "values": [ "App" ] } ]}

Response

200SUCCESS

404ERROR

Response
{ "task": { "status": "RUNNING", "taskId": "5e286bd4-b4b1-4c04-8f6a-123456789abc" }}
Response
{ "type": "about:blank", "title": "Not Found", "status": 404, "traceId": "1-000000-000000000000000"}

Get Report

GET

https://api.airbridge.io/reports/api/v4/apps/{app_name}/active-users/query/{task_id}

Request status

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

Request

Headers

Accept-Language
string

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

Content-Type
string

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

Authorization
string

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

Path Params

app_name
Requiredstring

Airbridge App Name. (Unique ID)

task_id
Requiredstring

The task_id returned by the result of the 'Request Report' API.

Request
curl -X GET 'https://api.airbridge.io/reports/api/v4/apps/{app_name}/active-users/query/{task_id}' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200SUCCESS

200SUCCESS

404ERROR

Response
{ "task": { "status": "SUCCESS", "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d", "endedAt": "2022-07-29T04:40:52+00:00" }, "activeUsers": { "data": [ { "rows": [ { "date": "2022-07-23T00:00:00+09:00/2022-07-24T00:00:00+09:00", "values": { "app_au": 7, "app_pu": 0, "app_arpu": 0, "app_arppu": 0, "app_revenue": 0 } }, { "date": "2022-07-24T00:00:00+09:00/2022-07-25T00:00:00+09:00", "values": { "app_au": 8, "app_pu": 0, "app_arpu": 0, "app_arppu": 0, "app_revenue": 0 } } ], "groupBys": [] } ] }}
Response
{ "task": { "status": "RUNNING", "taskId": "5e286bd4-b4b1-4c04-8f6a-123456789abc", "endedAt": "2023-01-01T09:00:00.286939+09:00" }}
Response
{ "type": "about:blank", "title": "Not Found", "status": 404, "traceId": "1-000000-000000000000000"}

Get Metadata (Metric)

GET

https://api.airbridge.io/dataspec/v1/apps/{app_name}/active-users-report/metrics

Query the available report metrics. [Note]

Request

Headers

Accept-Language
string

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

Content-Type
string

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

Authorization
string

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

Path Params

app_name
Requiredstring

Airbridge App Name. (Unique ID)

Request
curl -X GET 'https://api.airbridge.io/dataspec/v1/apps/{app_name}/active-users-report/metrics' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200SUCCESS

404ERROR

There is an error in the field provided, or there is no such resource.

Response
{ "data": [ { "name": "App", "metrics": [ { "key": "app_au", "name": "Active Users (App)", "description": "The number of unique users who performed any app event", "valueType": "integer", "isInactive": false }, { "key": "app_pu", "name": "Paying Users (App)", "description": "The number of unique users who performed the Revenue events(Order Complete, Subscribe, Ad Click, Ad Impression) in App", "valueType": "integer", "isInactive": false } ] }, { "name": "Web", "metrics": [ { "key": "web_au", "name": "Active Users (Web)", "description": "The number of unique users who performed any web event", "valueType": "integer", "isInactive": false }, { "key": "web_pu", "name": "Paying Users (Web)", "description": "The number of unique users who performed the Revenue events(Order Complete, Subscribe, Ad Click, Ad Impression) in Web", "valueType": "integer", "isInactive": false } ] } ]}
Response
{ "type": "about:blank", "title": "Not Found", "status": 404, "traceId": "1-000000-000000000000000"}

Get Metadata (GroupBy)

GET

https://api.airbridge.io/dataspec/v1/apps/{app_name}/active-users-report/groupbys

Gets a list of available report groupbys. [Note]

Request

Headers

Accept-Language
string

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

Content-Type
string

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

Authorization
string

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

Path Params

app_name
Requiredstring

Airbridge App Name. (Unique ID)

Request
curl -X GET 'https://api.airbridge.io/dataspec/v1/apps/{app_name}/active-users-report/groupbys' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

Response

200SUCCESS

404ERROR

There is an error in the field provided, or there is no such resource.

Response
{ "data": [ { "name": "Touchpoint", "fields": [ { "key": "channel", "name": "Channel", "description": "The media source of the touchpoint.", "example": "moloco", "isFilter": true, "isApp": true, "isWeb": true, "type": "string" }, { "key": "campaign", "name": "Campaign", "description": "The campaign that generated the touchpoint. The campaign name entered in SAN or collected by the campaign parameter of the tracking link.", "example": "2018_summer_campaign", "isFilter": true, "isApp": true, "isWeb": true, "type": "string" } ] }, { "name": "Device", "fields": [ { "key": "device_type", "name": "Device Type", "description": "Device Type\n- mobile\n- tablet\n- desktop\n- other", "example": "mobile", "isFilter": true, "isApp": true, "isWeb": true, "type": "string" }, { "key": "platform", "name": "Platform", "description": "Device Platform\n- Android\n- iOS\n- Desktop\n- Other", "example": "Android", "isFilter": true, "isApp": true, "isWeb": true, "type": "string" } ] } ]}
Response
{ "type": "about:blank", "title": "Not Found", "status": 404, "traceId": "1-000000-000000000000000"}