Active Users Report

Last updated March 21, 2024

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.

Request Report

POST

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

Try API Request

Request an Active Users Report.

Request

Headers

Accept-Language

string

您可指定用于 API 请求和结果返回的语言。遵守 ISO-639-1 格式。

Content-Type

string

表示资源的媒体类型。默认使用 application/json。

Authorization

string

用于 API 请求的键值。

Path Params

app_name

Requiredstring

Airbridge App 名称（App Name）

Body Params

from

Requiredstring

granularity

Requiredenum

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[]

groupBy

Requiredobject

filters

Requiredobject[]

Request

12345
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","metrics":["app_events"],"groupBy":{"fields":["channel"]},"filters":[{"filterType":"IN","field":"campaign","values":["App"]}]}'

Payload

12345678910111213141516171819202122
{
  "from": "2022-11-04",
  "to": "2022-11-11",
  "granularity": "day",
  "metrics": [
    "app_events"
  ],
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "filters": [
    {
      "filterType": "IN",
      "field": "campaign",
      "values": [
        "App"
      ]
    }
  ]
}

Response

200SUCCESS

404ERROR

Response

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

Response

123456
{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "traceId": "1-000000-000000000000000"
}
{
  "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}

Try API Request

Request status

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

`#{"style":{"minWidth":"130px"}}` `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.

Request

Headers

Accept-Language

string

您可指定用于 API 请求和结果返回的语言。遵守 ISO-639-1 格式。

Content-Type

string

表示资源的媒体类型。默认使用 application/json。

Authorization

string

用于 API 请求的键值。

Path Params

app_name

Requiredstring

Airbridge App 名称（App Name）

task_id

Requiredstring

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

Request

1234
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

404ERROR

Response

123456789101112131415161718192021222324252627282930313233343536
{
  "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": []
      }
    ]
  }
}
{
  "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

1234567
{
  "task": {
    "status": "RUNNING",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-123456789abc",
    "endedAt": "2023-01-01T09:00:00.286939+09:00"
  }
}
{
  "task": {
    "status": "RUNNING",
    "taskId": "5e286bd4-b4b1-4c04-8f6a-123456789abc",
    "endedAt": "2023-01-01T09:00:00.286939+09:00"
  }
}

Response

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

Was this page helpful?

Have any questions or suggestions?

Active Users Reportself.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

Request Report

Request

Headers

Path Params

Body Params

Response

200SUCCESS

404ERROR

Get Report

Request

Headers

Path Params

Response

200SUCCESS

200SUCCESS

404ERROR

Active Users Report