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

    可以指定用于 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
    to
    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[]

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

    可以指定用于 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

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

    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

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

    Content-Type
    string

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

    Authorization
    string

    用于 API 请求的键值。参阅 密钥的生成及查询方法 来获取该键值。

    Path Params

    app_name
    Requiredstring

    Airbridge App 名称（App Name）。

    Request
    1234
    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
    123456789101112131415161718192021222324252627282930313233343536373839404142
    {
  "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
        }
      ]
    }
  ]
}

    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

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

    Content-Type
    string

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

    Authorization
    string

    用于 API 请求的键值。参阅 密钥的生成及查询方法 来获取该键值。

    Path Params

    app_name
    Requiredstring

    Airbridge App 名称（App Name）。

    Request
    1234
    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
    123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
    {
  "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"
        }
      ]
    }
  ]
}

    Was this page helpful?

    Have any questions or suggestions?