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.


    Request Report

    POST

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

    Request an Active Users Report.

    Request

    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. 

    • The system only accepts dates within the 174 days preceding the current date. 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 90 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
    Requiredenum[]

    Report "Metrics".

    ENUM VALUES
    app_au

    Active Users (App). Users that generated an event via SDK at least once during the designated period.

    app_pu

    Paying Users (App). Users that have a purchase history during the designated period.

    app_revenue

    Revenue (App). Revenue generated by the users who performed in-app purchase. (In local currency)

    app_arpu

    ARPU (App). ARPU is calculated by dividing total revenue by the number of Active users. (In local currency)

    app_arppu

    ARPPU (App). ARPPU is calculated by dividing total revenue by the number of paying users. (In local currency)

    web_au

    Active Users (Web). The number of unique users who performed any web event

    web_pu

    Paying Users (Web). The number of unique users who performed the Order Complete events in Web

    web_revenue

    Revenue (Web). Sum of value generated from order complete events in Web

    web_arpu

    ARPU (Web). Average revenue per user in Web

    web_arppu

    ARPPU (Web). Average revenue per paying user in Web

    groupBy
    object

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

    filters
    object[]

    The groupBys to filter by.

    Only values defined within groupBys can be used.

    Request
    12345
    curl -X POST 'https://api.airbridge.io/reports/api/v4/apps/{app_name}/active-users/query' \
      -H 'Accept-Language: en' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
      -d '{"from":"2023-01-01","to":"2023-01-07","granularity":"day","metrics":["app_au"]}'
    Payload
    12345678
    {
      "from": "2023-01-01",
      "to": "2023-01-07",
      "granularity": "day",
      "metrics": [
        "app_au"
      ]
    }

    Response

    200 SUCCESS

    404 ERROR

    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

    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: en' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

    Response

    200 (Processing the request)SUCCESS

    200 (Completed the request processing)SUCCESS

    404 ERROR

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

    Was this page helpful?

    Have any questions or suggestions?