User GuideDeveloper GuideAPI
Dashboard

    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: No limit.

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

    Report "Metrics".

    Various ad performance data can be examined through metrics. Refer to the 'Report Metrics' for a comprehensive list of available options.

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

    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
    Requiredstring

    Airbridge App Name. (Unique ID)

    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

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

    Was this page helpful?

    Have any questions or suggestions?