Raw Data

    Airbridge's data export feature allows you to select and extract raw data from your marketing campaigns into a .csv file. Begin exporting via [Raw Data > Data Export]. Raw Data Export is available for App and Web in a separate section.


    Request Raw Data Export

    POST

    https://api.airbridge.io/log-export/api/v3/apps/{app_name}/{type}/request

    Request a Raw Data Export.

    Request

    Path Params

    app_name
    Requiredstring

    Airbridge App Name. (Unique ID)

    type
    Requiredenum

    The type of raw data. It can be set to web or app.

    ENUM VALUES
    app

    Export app data.

    web

    Export web data.

    Body Params

    dateRange
    Requiredobject

    Set the data export period.

    dateRange.start
    Requiredstring

    The start date of the report data to request.

    • The date must be in the format 'YYYY-MM-DD HH:mm:ss'

    • This date must correspond with the timezone set in the Airbridge app. 

    • The system only accepts dates within the 179 days preceding the current date. Future dates are not permitted.

    dateRange.end
    Requiredstring

    The end date of the report data to request.

    • The date must be in the format 'YYYY-MM-DD HH:mm:ss'

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

    events
    Requiredstring[]

    The event to be extracted. (App Event KeyWeb Event Key)

    properties
    Requiredstring[]

    The Property to be extracted. (App Event PropertiesWeb Event Properties)

    filters
    object[]

    The filter for providing 'group by' items.

    filters[0].field
    string

    The Properties to filter by.

    filters[0].condition
    object
    filters[0].condition.type
    Requiredenum

    The operator to apply to the filter.

    ENUM VALUES
    equal

    Equal (is, =).

    not_equal

    Does not equal (is not, ≠).

    in

    In.

    not_in

    Not in.

    exist

    Value exists.

    not_exist

    Value does not exist.

    lt

    Less then.

    lte

    Less then or equal.

    gt

    Greater then

    gte

    Greater then or equal

    between

    Between.

    filters[0].condition.type
    Requiredenum

    The operator to apply to the filter.

    ENUM VALUES
    equal

    Equal (is, =).

    not_equal

    Does not equal (is not, ≠).

    in

    In.

    not_in

    Not in.

    exist

    Value exists.

    not_exist

    Value does not exist.

    lt

    Less then.

    lte

    Less then or equal.

    gt

    Greater then

    gte

    Greater then or equal

    between

    Between.

    filters[0].condition.values
    Requiredstring[]

    The value to apply to the filter. Used when the type is "in", "not_in".

    filters[0].condition.values
    Requiredstring[]

    The value to apply to the filter. Used when the type is "in", "not_in".

    filters[0].condition.value
    Requiredstring

    The value to apply to the filter. Used when the type is "equal", "not_equal", "lt", "lte", "gt", "gte".

    filters[0].condition.value
    Requiredstring

    The value to apply to the filter. Used when the type is "equal", "not_equal", "lt", "lte", "gt", "gte".

    filters[0].condition.start
    Requiredstring

    Start date if type is between.

    filters[0].condition.start
    Requiredstring

    Start date if type is between.

    filters[0].condition.end
    Requiredstring

    End date if type is between.

    filters[0].condition.end
    Requiredstring

    End date if type is between.

    Response

    200 SUCCESS

    404 ERROR


    Get Raw Data Export

    GET

    https://api.airbridge.io/log-export/api/v3/apps/{app_name}/request/{report_id}

    Gets the URL where the results of the raw data export can be downloaded.

    Request

    Path Params

    app_name
    Requiredstring

    Airbridge App Name. (Unique ID)

    report_id
    Requiredinteger

    The report_id returned by the result of the 'Request Raw Data Export' API.

    Response

    200 SUCCESS

    404 ERROR

    Was this page helpful?

    Have any questions or suggestions?