User GuideDeveloper GuideAPI
Dashboard

    Retention Report

    The Retention Report shows how many users returned to the app a certain number of days after installing the app or opening the app through a deep link.

    You can identify the channels and campaigns that attract the most active app users. The retention data can be used for campaign optimization and ad billings.

    Request Report

    POST

    https://api.airbridge.io/reports/api/v5/apps/{app_name}/retention/query

    Try API Request

    Request a Retention 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 31 days.

    granularity
    Requiredenum

    The analytics interval period.

    ENUM VALUES
    day

    Analyze the data by day.

    week

    Analyze the data by week. The week is calculated from Monday to Sunday.

    month

    Analyze the data by month. The month is calculated from the first date to the last day of the month. For instance, if you request a date from March 10 to April 10, count it as 3/10-3/31 and 04/01-04/10.

    startEvent
    Requiredenum

    The event that initiates a User Journey in the time period set.

    ENUM VALUES
    app_installs

    Installs (App). Install events that occurred within the selected time period.

    app_deeplink_opens

    Deeplink Opens (App). Deeplink Open events that occurred within the selected time period.

    returnEvents
    Requiredstring[]

    An in-app event performed by the user after performing a Start Event.

    Accept Airbridge Standard Events and Custom Events that have been collected at least once. Any event can be set as a return event with any_event.

    measurementOption
    Requiredenum

    The option to view the retention by unique users or by user journeys that are separated by Start Events. [Reference]

    ENUM VALUES
    general_retention

    General. A User Journey of a unique user is initiated by the Start Event performed by that user.

    confined_retention

    Confined. A User Journey of a unique user is initiated by the Start Event performed by that user. The Airbridge Device ID is used to identify unique users.

    groupBy
    object

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

    groupBy.fields
    string[]

    Report "Group By".

    'Group By' is necessary when seeking a more detailed view in reports. This specification will allow reports to be grouped according to desired criteria. Refer to the 'Report GroupBys' for a comprehensive list of available options.

    The maximum threshold is 4.

    filters
    object[]

    The filter for providing 'group by' items.

    filters[0].field
    Requiredstring

    The groupBys to filter by.

    Only values defined within groupBys can be used.

    filters[0].filterType
    Requiredenum

    The operator to apply to the filter.

    ENUM VALUES
    IN

    In. In Retention Reports, this corresponds to equals (is, =).

    NOT IN

    Not in. In Retention Reports, this corresponds to is not, ≠.

    EXIST

    Value exists.

    NOT EXIST

    Value does not exist.

    filters[0].values
    string[]

    The value to apply to the filter.

    sorts
    Requiredobject[]

    Sort report data by 'Group By'

    sorts[0].fieldName
    Requiredstring

    Values within 'groupBys' serve as criteria for sorting.

    sorts[0].isAscending
    Requiredboolean

    Sort by ascending (A-Z) or not. (Default: true)

    keyword
    string

    The keywords to filter on GroupBy in the results.

    pagination
    object
    pagination.skip
    Requiredinteger

    The number of objects to be skipped.

    The default is 0.

    pagination.size
    Requiredinteger

    A limit on the number of objects to be returned.

    The default is 100.

    Response

    200 SUCCESS

    400 ERROR

    The field contains an error or is incorrectly formatted.

    Get Report

    GET

    https://api.airbridge.io/reports/api/v5/apps/{app_name}/retention/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

    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.

    Query Params

    skip
    string

    The number of objects to be skipped.

    The default is 0.

    size
    string

    A limit on the number of objects to be returned.

    The default is 100.

    Response

    200 (Processing the request)SUCCESS

    200 (Completed the request processing)SUCCESS

    404 ERROR

    Was this page helpful?

    Have any questions or suggestions?