Revenue Report

Path Params

app_name

Requiredstring

Airbridge App Name. (Unique ID)

Body Params

from

Requireddatetime

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.

Requireddatetime

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.

groupBy

Requiredobject

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

groupBy.fields

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. The 'Report GroupBys' for a comprehensive list of available options.

The maximum threshold is 4.

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.

startEvents

Requiredenum[]

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

Users who do not trigger the set event are not analyzed in the report.

ENUM VALUES

app_install

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

app_deeplink_open

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

returnEvents

Requiredenum[]

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

It is possible to set up multiple return events.

ENUM VALUES

app_order_complete

Order Complete (App). Order Complete event performed within the selected time period.

app_first_order_complete

First Order Complete (App). First Order Complete event performed within the selected time period.

app_ad_impression

Ad Impression (App). Ad Impression event performed within the selected time period.

app_ad_click

Ad Click (App). Ad Click event performed within the selected time period.

app_subscribe

Subscribe (App). Subscribe event performed within the selected time period.

metric

Requiredenum

Report "Metrics".

ENUM VALUES

app_revenue

Revenue(App). The revenue generated by the users who performed the Start Event and the Return Event. (In local currency) Support cumulative, on-day aggregation type.

app_user_count

User Count (App). The total number of unique users who performed revenue events. Support cumulative, on-day aggregation type.

app_event_count

Event Count (App). The total number of revenue events. Support cumulative, on-day aggregation type.

app_roas

ROAS (App). The return on ad spend of the users who performed the Start Event and the Retrun Event. (In local currency) Support cumulative aggregation type.

app_arpu

ARPU (App). The average revenue per user who performed the Start Event. (In local currency) Support cumulative aggregation type.

app_arppu

ARPPU (App). The average revenue per paying user who performed the Start Event. (In local currency) Support cumulative aggregation type.

aggregationType

Requiredenum

View types for the report. [Reference]

ENUM VALUES

cumulative

Cumulative aggregation. Accumulate numbers from the first day of the analysis period (Day 0) to the last day (Day N).

on-day

On Day (N-Day). View the isolated data of each day.

filters

object[]

The filter for providing 'group by' items.

filters[0].field

string

The groupBys to filter by.

Only values defined within groupBys can be used.

filters[0].filterType

enum

The operator to apply to the filter.

ENUM VALUES

IS

Equal (is, =).

IS NOT

Does not equal (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' or 'Metric'.

sorts.[0].fieldName

Requiredstring

Values within groupBy.dimensions or subMetrics serve as criteria for sorting.

sorts.[0].isAscending

boolean

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

resultSpec

object

The format of the result.

resultSpec.csv

object

The csv format of the result.

resultSpec.csv.includesMetadata

boolean

Whether to include metadata. (selected StartEvent, groupBy, etc.)

resultSpec.csv.includesTotal

boolean

Whether to include total value.

Request

12345
curl -X POST 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/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","groupBy":{"fields":["channel"]},"granularity":"day","startEvents":["app_install"],"returnEvents":["app_order_complete"],"metric":"app_revenue","aggregationType":"cumulative","sorts":[{"fieldName":"totalRevenue","isAscending":true}],"resultSpec":{"csv":{"includesTotal":true}}}'

Payload

1234567891011121314151617181920212223242526272829
{
  "from": "2023-01-01",
  "to": "2023-01-07",
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "granularity": "day",
  "startEvents": [
    "app_install"
  ],
  "returnEvents": [
    "app_order_complete"
  ],
  "metric": "app_revenue",
  "aggregationType": "cumulative",
  "sorts": [
    {
      "fieldName": "totalRevenue",
      "isAscending": true
    }
  ],
  "resultSpec": {
    "csv": {
      "includesTotal": true
    }
  }
}

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

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

`#{"style":{"minWidth":"310px"}}` `AGG_DATA_MASKING_BY_FACEBOOK`	The data has been removed according to Meta's privacy compliance policies.
`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.

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

AGG_DATA_MASKING_BY_FACEBOOK

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

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.

curl -X GET 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query/{task_id}' \ -H 'Accept-Language: en' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

{ "data": { "stats": { "rows": [ { "rows": [ { "date": "2021-11-01", "total": { "totalCost": { "value": 0 }, "totalRevenue": { "value": 10 }, "totalUniqueUsers": { "value": 1, "isMasked": true } }, "values": [ { "value": 1, "isMasked": false }, { "value": 2, "isMasked": false }, { "value": 3, "isMasked": false }, { "value": 4, "isMasked": false } ] } ], "total": { "rows": [ { "value": 1, "isMasked": false }, { "value": 2, "isMasked": false }, { "value": 3, "isMasked": false }, { "value": 4, "isMasked": false } ], "totalCost": { "value": 0 }, "totalRevenue": { "value": 10.45 }, "totalUniqueUsers": { "value": 1, "isMasked": false } }, "metadata": [ "<groupBy>" ] } ] }, "status": "SUCCESS", "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d", "endedAt": "2022-01-17T19:10:00.286939+09:00", "hasNext": false, "metadata": { "totalCount": 48 } }, "notification": [ { "code": "AGG_DATA_MASKING_BY_FACEBOOK", "type": "info", "message": "some data is masked by facebook privacy policy." } ] }

Request Report

Request

Path Params

Body Params

Response

200 SUCCESS

400 ERROR

Get Report

Request

Path Params

Response

200 SUCCESS

404 ERROR

Revenue Reportself.__wrap_n!=1&&self.__wrap_b(":R29lllb7ammda:",0.5)

Request Report

Request

Path Params

Body Params

Response

200 SUCCESS

400 ERROR

Get Report

Request

Path Params

Response

200 SUCCESS

404 ERROR

Revenue Report