Actuals Report

    Actuals Report provides customization features for the metrics and data you intend to analyze.

    Using the various data fields provided by Airbridge, you can customize the report in all forms such as subdividing data into specific criteria, adding metrics on granular criteria, or applying filters.


    Request Report

    POST

    https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/query

    Request Actuals 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 365 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 92 days.

    groupBys
    Requiredstring[]

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

    filters
    Requiredobject[]

    The filter for providing 'group by' items.

    filters[0].dimension
    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 Actuals reports, this corresponds to equals (is, =).

    NOT IN

    Not in. In Actuals reports, this corresponds to is not, ≠.

    LIKE

    Contains. ∋

    NOT LIKE

    Does not contain. ∌

    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' or 'Metric'.

    sorts[0].fieldName
    Requiredstring

    Values within 'groupBys' or 'metrics' serve as criteria for sorting.

    sorts[0].isAscending
    boolean

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

    Response

    200 SUCCESS

    task.status

    #{"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.

    404 ERROR


    Get Report

    GET

    https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/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 complete and returns the result.

    FAILURE

    The request has failed.

    CANCELED

    The request has been canceled.

    Response Notification

    If certain data was removed or masked during aggregation (masking), refer to the the reason in notification[0].code.

    #{"style":{"minWidth":"310px"}}

    MEDIA_PARTNER_DATA_FILTERED_BY_CHANNEL

    The media partner requesting the data has not been granted the permission to view them.

    AGG_DATA_MASKING_BY_FACEBOOK

    The data has been removed according to Meta's privacy compliance policies.

    EXCEEDED_LIMIT_ON_MAX_ROW_COUNT

    The result has exceeded the maximum data value (10,000 rows per report). It is recommended that data is extracted using Raw Data Export.

    SAN_PERIOD_LIMIT

    The data has been removed according to Self-Attribution Networks' compliance policies. For example, removed data from 175 days ago that was attributed to Meta.

    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
    number

    The number of objects to be skipped.

    The default is 0.

    size
    number

    A limit on the number of objects to be returned.

    The default is 100.

    keyword
    string

    The keywords to filter on GroupBy in the results.

    viewFormat
    boolean

    The format type used by the dashboard to represent values for the Actuals Report.

    If it set true, the values are express in "Number + α" format.

    Response

    200 (Processing the request)SUCCESS

    The asynchronous request is being processed.

    The API can be polled periodically to see the results, and the status of the request can be checked with task.status.

    200 (Completed the request processing)SUCCESS

    Returns the result when data aggregation is complete. If status is SUCCESS, sends it to actuals with data, metadata, messages, etc.


    Get Metadata (GroupBy)

    GET

    https://api.airbridge.io/dataspec/v2/apps/{app_name}/actual-report/fields

    Gets a list of available report groupbys. [Note]

    Request

    Path Params

    app_name
    Requiredstring

    Airbridge App Name. (Unique ID)

    Response

    200 SUCCESS

    404 ERROR

    There is an error in the field provided, or there is no such resource.


    Get Metadata (Metric)

    GET

    https://api.airbridge.io/dataspec/v2/apps/{app_name}/actual-report/metrics

    Query the available report metrics. [Note]

    Request

    Path Params

    app_name
    Requiredstring

    Airbridge App Name. (Unique ID)

    Response

    200 SUCCESS

    404 ERROR

    There is an error in the field you entered, or there is no such resource.

    Was this page helpful?

    Have any questions or suggestions?