Revenue Report

Headers

Accept-Language

string

You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.

Content-Type

string

Represents the media type of the resource. Defaults to application/json.

Authorization

string

The key value to use for API requests. Instructions for getting API keys are in "how to generate API Keys".

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.
Future dates are not permitted.

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.

cohorts

object[]

Only one cohort can be set up.

You can see an example of cohort code here.

cohorts[0].id

Requirednumber

The value should be entered as 0. Other values are not supported.

cohorts[0].name

Requiredstring

The value should be entered as "Cohort". Other values are not supported.

cohorts[0].definition

Requiredobject

Define the cohorts used by the Revenue Report. Always define sub-variables in the order andClauses, orClauses, segment. Check the relationship between each variable below.

cohorts[0].definition.andClauses

Requiredobject[]

The highest-level condition in the cohort definition. All conditions you set are connected with an AND. You must set negated and orClauses as sub-variables.

negated (boolean): Sets whether the condition you set in orClauses is negated.
- true: Negates the condition you set in orClauses, so the condition you set in orClauses is false.
- false: Does not negate the condition set in orClauses. Therefore, the condition set in orClauses is true.

cohorts[0].definition.andClauses[*].orClauses | Required ・ object[]

The conditions you set in the child of andClauses. Connect all the conditions you set with an OR. You must set negated and segment as sub-variables.

negated (boolean): Sets whether the condition set in orClauses is negated.
- true: Negates the condition you set in orClauses, so the condition you set in orClauses is false.
- false: Does not negate the condition set in the orClauses. Therefore, the condition set in the orClauses is true.

cohorts[0].definition.andClauses[*].orClauses[*].segment | Required ・ object

The minimum conditions for a cohort definition. You can set event, filters, and time as sub-variables.

event (object): You can define an event triggered by the user and the number of times it occurs. You can set type, operator, and value as sub-variables.
- type (string): type (string): Sets the event generated by the user. You can set it to any event by using any-event. Other events that can be set can be found in the Event Key column of [Airbridge Data Spec]>[Revenue Report - Audience Events]. Please be aware of the use of '' and _.
- operator (enum): You can set the comparison operator used for the number of times an event occurs. You can only use one of five: equals, more than or equals, more than, less than or equals, and less than.
- value (number): You can set the number of times the event occurs. Please enter a natural number.
filters (object[]): You can only see certain events out of the ones you have defined. It's the same as the had property in the cohort definition. You can set field and filterType as sub-variables.
- field (string): Properties that can be set as filters. Please refer to the Property Key column of [Airbridge Data Spec] > [Revenue Report - Audience Properties] for the properties that can be set.
- filterType (enum): Sets the operators that can be used on the property. Depending on the property you set, the available operators and the values you set with the filter (none, value, values) change.

filterType	Property Data Type	Sub-variables
is / is not	string, boolean	values
contains / does not contain	string	value
exists / does not exist	string, boolean, int, float	N/A
equals / does not equal	int, float	value
does not equal	int, float	value
greater than or equals	int, float	value
greater than	int, float	value
less than or equals	int, float	value
less than	int, float	value
between	int, float	values
does not between	int, float	value

time (object): You can set conditions for when the event occurred. The subvariable will change based on the set condition.
- operator (enum): Set the condition from during, between, or since. Only one of the three can be set. If the condition is between, the lookup period can be set from 1 February 2023. The maximum period you could set is 90 days.

Operator	Sub-variables	Description
during	values, isNowEnabled	isNowEnabled sets whether to include today
between	values	Values must have both start and end dates set.
since	values	Set start date only

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.

intervalsPeriod

integer

The maximum number of intervals, or time ranges, by granularity.

If the granularity is day, week, or month, the default value is 30, 11, or 5, respectively.
If the granularity is day, week, or month, the maximum value is 120, 52, or 36, respectively. The minimum values are all 0.
The result includes a “0th” interval.

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.

app_deeplink_pageview

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

app_sign_up

Sign-up (App). Sign-up events that occurred within the selected time period.

app_sign_in

Sign-in (App). Sign-in 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

Requiredobject[]

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

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: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"from":"2022-11-04","to":"2022-11-11","groupBy":{"fields":["channel"]},"granularity":"day","intervalsPeriod":30,"startEvents":["app_install"],"returnEvents":["app_order_complete"],"metric":"app_revenue","aggregationType":"cumulative","filters":[{"field":"campaign","filterType":"IN","values":["App"]}],"sorts":[{"fieldName":"totalRevenue","isAscending":true}],"resultSpec":{"csv":{"includesTotal":true}}}'
curl -X POST 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"from":"2022-11-04","to":"2022-11-11","groupBy":{"fields":["channel"]},"granularity":"day","intervalsPeriod":30,"startEvents":["app_install"],"returnEvents":["app_order_complete"],"metric":"app_revenue","aggregationType":"cumulative","filters":[{"field":"campaign","filterType":"IN","values":["App"]}],"sorts":[{"fieldName":"totalRevenue","isAscending":true}],"resultSpec":{"csv":{"includesTotal":true}}}'

Payload

123456789101112131415161718192021222324252627282930313233343536373839
{
  "from": "2022-11-04",
  "to": "2022-11-11",
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "granularity": "day",
  "intervalsPeriod": 30,
  "startEvents": [
    "app_install"
  ],
  "returnEvents": [
    "app_order_complete"
  ],
  "metric": "app_revenue",
  "aggregationType": "cumulative",
  "filters": [
    {
      "field": "campaign",
      "filterType": "IN",
      "values": [
        "App"
      ]
    }
  ],
  "sorts": [
    {
      "fieldName": "totalRevenue",
      "isAscending": true
    }
  ],
  "resultSpec": {
    "csv": {
      "includesTotal": true
    }
  }
}
{
  "from": "2022-11-04",
  "to": "2022-11-11",
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "granularity": "day",
  "intervalsPeriod": 30,
  "startEvents": [
    "app_install"
  ],
  "returnEvents": [
    "app_order_complete"
  ],
  "metric": "app_revenue",
  "aggregationType": "cumulative",
  "filters": [
    {
      "field": "campaign",
      "filterType": "IN",
      "values": [
        "App"
      ]
    }
  ],
  "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.

curl -X GET 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query/{task_id}?skip=0&size=50' \ -H 'Accept-Language: ko' \ -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." } ] }

curl -X GET 'https://api.airbridge.io/dataspec/v1/apps/{app_name}/revenue-report/metrics' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

{ "data": [ { "name": "Metric", "metrics": [ { "key": "app_revenue", "name": "Revenue", "description": "Sum of value generated from revenue events", "valueType": "number", "aggregationType": [ "cumulative", "on-day" ] }, { "key": "app_user_count", "name": "User Count", "description": "The total number of unique users who performed revenue events", "valueType": "integer", "aggregationType": [ "on-day", "unique-cumulative" ] } ] }, { "name": "Sub Metric", "metrics": [ { "key": "customer_acquisition_cost", "name": "CAC", "description": "Customer Acquisition Cost; the average cost to acquire a user who performed Start Event within the set date range<br>Total Cost/Users", "valueType": "number", "aggregationType": null }, { "key": "start_event_users", "name": "Users", "description": "The number of users who performed Start Event to open the app within the set date range", "valueType": "integer", "aggregationType": null } ] } ] }

curl -X GET 'https://api.airbridge.io/dataspec/v1/apps/{app_name}/revenue-report/groupbys' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

{ "data": [ { "name": "Event Details", "fields": [ { "key": "is_first_event_per_user_id", "name": "Is First Event per User ID", "description": "Boolean type data to show whether the event has happened in the past. (per user id)\n- true: First Event. \n- false: Not the First Event\n\n(Both Web/App Event Available)", "example": "true", "isFilter": true, "type": "boolean", "isCost": false }, { "key": "is_first_event_per_device_id", "name": "Is First Event per Device ID", "description": "Boolean type data to show whether the event has happened in the past. (per airbridge device id)\n- true: First Event. \n- false: Not the First Event\n\n(App Event Available Only)", "example": "true", "isFilter": true, "type": "boolean", "isCost": false } ] }, { "name": "Touchpoint", "fields": [ { "key": "channel", "name": "Channel", "description": "The media source of the touchpoint.", "example": "moloco", "isFilter": true, "type": "string", "isCost": true }, { "key": "campaign", "name": "Campaign", "description": "The campaign that generated the touchpoint. The campaign name entered in SAN or collected by the campaign parameter of the tracking link.", "example": "2018_summer_campaign", "isFilter": true, "type": "string", "isCost": true } ] } ] }

curl -X GET 'https://api.airbridge.io/dataspec/v1/apps/{app_name}/revenue-report/events' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

{ "data": [ { "name": "Return Event", "events": [ { "subGroup": "App Standard Event", "key": "app_first_order_complete", "name": "First Order Complete (App)", "description": "First Order Complete (App) event performed by users who performed the start event within the set date range" }, { "subGroup": "App Standard Event", "key": "app_order_complete", "name": "Order Complete (App)", "description": "Order Complete (App) event performed by users who performed the start event within the set date range" } ] }, { "name": "Start Event", "events": [ { "subGroup": "", "key": "app_install", "name": "Install (App)", "description": "Install occurred within the set date range" }, { "subGroup": "", "key": "app_deeplink_open", "name": "Deeplink Open (App)", "description": "Deeplink Open occurred within the set date range" } ] } ] }

Request Report

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

Get Report

Request

Headers

Path Params

Query Params

Response

200SUCCESS

404ERROR

Get Metadata (Metric)

Request

Headers

Path Params

Response

200SUCCESS

404ERROR

Get Metadata (GroupBy)

Request

Headers

Path Params

Response

200SUCCESS

404ERROR

Get Metadata (Event)

Request

Headers

Path Params

Response

200SUCCESS

404ERROR

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

Request Report

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

Get Report

Request

Headers

Path Params

Query Params

Response

200SUCCESS

404ERROR

Get Metadata (Metric)

Request

Headers

Path Params

Response

200SUCCESS

404ERROR

Get Metadata (GroupBy)

Request

Headers

Path Params

Response

200SUCCESS

404ERROR

Get Metadata (Event)

Request

Headers

Path Params

Response

200SUCCESS

404ERROR

Revenue Report