Request Report

The Revenue Report allows you to view the revenue generated by users who installed the app or opened a deep link during the analysis period. Various revenue metrics and filters are available to create a customized report. Additionally, there are no rate limits, allowing you to generate reports as needed. Request a Revenue Report. rate limit: There is no specific limit for normal usage. However, if excessive requests that may threaten service stability are detected, a temporary 429 Too Many Requests response may be returned.

Try API Request

POST

https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query

Request

Headers

string

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

string

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

string

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

Path Params

string

required

Airbridge App Name. (Unique ID)

Body Params

string

required

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.

string

required

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.

object[]

Only one cohort can be set up.You can see an example of cohort code here.

Show child attributes

number

required

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

string

required

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

object

required

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.

Show child attributes

object[]

required

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 ・ objectThe 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

object

required

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

Show child attributes

string[]

required

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.

enum

required

The analytics interval period.

Value	Description
`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.

number[]

This defines the interval ranges provided for each granularity. Revenue Report results are split into multiple intervals depending on the selected granularity.

0 (Day 0) is not added automatically. It is included only when explicitly requested by the user.
When the granularity is day, week, or month, the selectable ranges are:
- 0–180for day
- 0–52for week
- 0–36for month
When the granularity is hour or minute, this option is not used. The interval values are fixed at:
- 23for hour
- 59for minute

enum[]

required

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.

Value	Description
`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.

enum[]

required

An in-app event performed by the user after performing a Start Event.It is possible to set up multiple return events.

Value	Description
`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.

enum

required

Report “Metrics”.

Value	Description
`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.

enum

required

View types for the report. [Reference]

Value	Description
`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.

object[]

required

The filter for providing ‘group by’ items.

Show child attributes

string

required

The groupBys to filter by.Only values defined within groupBys can be used.

enum

required

The operator to apply to the filter.

Value	Description
`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.

string[]

The value to apply to the filter.

object[]

required

Sort report data by ‘Group By’ or ‘Metric’.

Show child attributes

string

required

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

boolean

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

object

The format of the result.

Show child attributes

object

The csv format of the result.

Show child attributes

boolean

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

boolean

Whether to include total value.

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",
  "intervalsPeriodIndexes": [
    1,
    3,
    7
  ],
  "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
    }
  }
}'

Response

200

400

{
  "data": {
    "taskId": "5e286bd4-b4b1-4c04-8f6a-asdf1234zxcv"
  }
}

{}

API Reference

Tracking Link

Server-to-Server Event

Actuals Report

Revenue Report

Active Users Report

Retention Report

Raw Data

Attribution Result

Self-Serve Data Upload

SKAdNetwork Configuration API

Try API Request

Request

Headers

Path Params

Body Params

Response

200

400

Try API Request

​Request

​Headers

​Path Params

​Body Params

​Response

​200

​400

Request

Headers

Path Params

Body Params

Response

200

400