You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.
Represents the media type of the resource. Defaults to application/json
.
The key value to use for API requests. Instructions for getting API keys are in "how to generate API Keys".
Airbridge App Name. (Unique ID)
Only one cohort can be set up.
You can see an example of cohort code here.
The value should be entered as 0. Other values are not supported.
The value should be entered as "Cohort". Other values are not supported.
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.
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 inorClauses
is negated.true
: Negates the condition you set inorClauses
, so the condition you set inorClauses
is false.false
: Does not negate the condition set inorClauses
. Therefore, the condition set inorClauses
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 inorClauses
is negated.true
: Negates the condition you set inorClauses
, so the condition you set inorClauses
is false.false
: Does not negate the condition set in theorClauses
. Therefore, the condition set in theorClauses
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 settype
,operator
, andvalue
as sub-variables.type
(string): type (string): Sets the event generated by the user. You can set it to any event by usingany-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
, andless 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 setfield
andfilterType
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 fromduring
,between
, orsince
. Only one of the three can be set. If the condition isbetween
, 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 |
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.
The maximum number of intervals, or time ranges, by granularity.
If the granularity is
day
,week
, ormonth
, the default value is30
,11
, or5
, respectively.If the granularity is
day
,week
, ormonth
, the maximum value is120
,52
, or36
, respectively. The minimum values are all0
.The result includes a “0th” interval.
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.
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.
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.
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.
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.