Active Users Report

2024年3月21日に最終更新

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

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

必須string

Airbridge App Name. (Unique ID)

Body Params

from

必須string

granularity

必須enum

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

必須string[]

groupBy

必須object

filters

必須object[]

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

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

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

必須string

Airbridge App Name. (Unique ID)

task_id

必須string

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

このページは役に立ちましたか？

ご質問やご提案はありますか？

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