Reporting API Controller

advertiser Controller

Advertisers are the entities offering products or services to consumers over the (desktop or mobile) web or via a mobile app.

advertiser/stats Controller

Advertiser Stats include the clicks, installs, updates, opens, andevents measured for your mobile app at the time the end user generatedthem.

advertiser/stats/count Method

Get the count

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the StatAdvertiser model.
groupArrayList of identifier fields of 'advertiser stat' record to group results by. See the StatAdvertiser model.
timestampStringSet to breakdown stats by timestamp choices: hour, datehour, date, week, month
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/define Method

define

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArraySee the StatAdvertiser model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/find Method

Find stats

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the StatAdvertiser model.
fieldsArrayList of fields from the StatAdvertiser model desired in results. Defaults to display all fields.
limitIntegerLimit the number of StatAdvertiser items returned per request.
pageIntegerPagination offset of the limited result set.
sortSortFields of StatAdvertiser followed by the direction (asc or desc). Results can be sorted with multiple fields and directions.
groupArrayList of identifier fields of 'advertiser stat' record to group results by. See the StatAdvertiser model.
timestampStringSet to breakdown stats by timestamp choices: hour, datehour, date, week, month
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

Related Models

advertiser/stats/find_export_queue Method

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the StatAdvertiser model.
fieldsArrayList of fields from the StatAdvertiser model desired in results. Defaults to display all fields.
groupArraySee the StatAdvertiser model.
timestampStringSet to breakdown stats by timestamp choices: hour, datehour, date, week, month
formatStringjson, csv
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/status Method

Return status of export job

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
job_id (required)String
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

Related Models

advertiser/stats/actuals Controller

Advertiser Actuals is based on when the respective clicks, installs, updates, opens, and events occur; i.e. the time the user actuallygenerated them. Unlike the Log report which is a simple log of eachattribution related to your mobile app, the Actuals report includescustomizable visualizations of your data of interest.

advertiser/stats/actuals/count Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the ReportingReport model
groupArraySee the ReportingReport model.
timestampStringSet to breakdown stats by timestamp choices: hour, datehour, date, week, month
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/actuals/define Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArraySee the ReportingReport model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/actuals/export Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the ReportingReport model
fieldsArrayList of fields from the ReportingReport model desired in results. Defaults to display all fields.
sortSortFields of ReportingReport followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport model.
timestampStringSet to breakdown stats by timestamp choices: hour, datehour, date, week, month
formatStringjson, csv
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/actuals/find Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the ReportingReport model
fieldsArrayList of fields from the ReportingReport model desired in results. Defaults to display all fields.
limitIntegerLimit the number of ReportingReport items returned per request.
pageInteger
sortSortFields of ReportingReport followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. See the ReportingReport model.
groupArraySee the ReportingReport model.
timestampStringSet to breakdown stats by timestamp choices: hour, datehour, date, week, month
formatStringjson, csv
partner_selected_advertiser_idInteger
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/actuals/status Method

Return status of export job

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
job_id (required)String
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

Related Models

advertiser/stats/actuals/tmc Controller

Advertiser Actuals is based on when the respective clicks, installs, updates, opens, and events occur; i.e. the time the user actuallygenerated them. Unlike the Log report which is a simple log of eachattribution related to your mobile app, the Actuals report includescustomizable visualizations of your data of interest.

advertiser/stats/actuals/tmc/define Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArraySee the ReportingReport model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/actuals/tmc/find Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
site_id (required)Integer
no_cacheBoolean
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/actuals/tmc/status Method

Return status of export job

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
job_id (required)String
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

Related Models

advertiser/stats/clicks Controller (deprecated)

advertiser/stats/clicks/count Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogClicks model
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

The number of 'click log' records matching filter criteria.

Returns: integer

Related Models

advertiser/stats/clicks/define Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArrayList of related entities to include define data for. Set to * to get define data for all related entities. See the LogClicks model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Details of entity 'advertiser/stats/clicks' expressed as follows: {fields: {FIELD_NAME: {type: DATA_TYPE, auto_return: BOOLEAN, default: VALUE}} related_entities:{NAME: {endpoint: API_ENDPOINT}}}

Returns: object

Related Models

advertiser/stats/clicks/find Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_keyStringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogClicks model
fieldsArrayList of fields from the LogClicks model desired in results. Defaults to display all fields.
limitIntegerLimit the number of Clicks items returned per request.
pageIntegerPagination offset of the limited result set.
sortSortFields of LogClicks followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

List of found 'click log' records that matched filter criteria.

Returns: array

Related Models

advertiser/stats/clicks/find_export_queue Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_keyStringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogClicks model
fieldsArrayList of fields from the LogClicks model desired in results. Defaults to display all fields.
formatStringjson, csv
backgroundBooleanIf true, then add job request to queue and run in background, else execute immediately.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Job identifier returned from queue and used for exporting results.

Returns: string

Related Models

advertiser/stats/event Controller (deprecated)

advertiser/stats/event/items Controller (deprecated)
advertiser/stats/event/items/count Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogEventItems model
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

The number of 'eventitem log' records matching filter criteria.

Returns: integer

Related Models

advertiser/stats/event/items/define Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArrayList of related entities to include define data for. Set to * to get define data for all related entities. See the LogEventItems model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Details of entity 'advertiser/stats/event/items' expressed as follows: {fields: {FIELD_NAME: {type: DATA_TYPE, auto_return: BOOLEAN, default: VALUE}} related_entities:{NAME: {endpoint: API_ENDPOINT}}}

Returns: object

Related Models

advertiser/stats/event/items/find Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogEventItems model
fieldsArrayList of fields from the LogEventItems model desired in results. Defaults to display all fields.
limitIntegerLimit the number of LogEventItems items returned per request.
pageIntegerPagination offset of the limited result set.
sortSortFields of LogEventItems followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

List of found 'eventitem log' records that matched filter criteria.

Returns: array

Related Models

advertiser/stats/event/items/find_export_queue Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogEventItems model
fieldsArrayList of fields from the LogEventItems model desired in results. Defaults to display all fields.
formatStringjson, csv
backgroundBooleanIf true, then add job request to queue and run in background, else execute immediately.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Job identifier returned from queue and used for exporting results.

Returns: string

Related Models

advertiser/stats/events Controller (deprecated)

advertiser/stats/events/count Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogEvents model
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

The number of 'event log' records matching filter criteria.

Returns: integer

Related Models

advertiser/stats/events/define Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArrayList of related entities to include define data for. Set to * to get define data for all related entities. See the LogEvents model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Details of entity 'advertiser/stats/events' expressed as follows: {fields: {FIELD_NAME: {type: DATA_TYPE, auto_return: BOOLEAN, default: VALUE}} related_entities:{NAME: {endpoint: API_ENDPOINT}}}

Returns: object

Related Models

advertiser/stats/events/find Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogEvents model
fieldsArrayList of fields from the LogEvents model desired in results. Defaults to display all fields.
limitIntegerLimit the number of Events items returned per request.
pageIntegerPagination offset of the limited result set.
sortSortFields of Events followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. See the LogEvents model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

List of found 'event log' records that matched filter criteria.

Returns: array

Related Models

advertiser/stats/events/find_export_queue Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogEvents model
fieldsArrayList of fields from the LogEvents model desired in results. Defaults to display all fields.
formatStringjson, csv
backgroundBooleanIf true, then add job request to queue and run in background, else execute immediately.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Job identifier returned from queue and used for exporting results.

Returns: string

Related Models

advertiser/stats/installs Controller (deprecated)

advertiser/stats/installs/count Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

The number of 'install log' records matching filter criteria.

Returns: integer

Related Models

advertiser/stats/installs/define Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArrayList of related entities to include define data for. Set to * to get define data for all related entities. See the LogInstalls model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Details of entity 'advertiser/stats/installs' expressed as follows: {fields: {FIELD_NAME: {type: DATA_TYPE, auto_return: BOOLEAN, default: VALUE}} related_entities:{NAME: {endpoint: API_ENDPOINT}}}

Returns: object

Related Models

advertiser/stats/installs/find Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fieldsArrayList of fields from the LogInstalls model desired in results. Defaults to display all fields. See the LogInstalls model.
limitIntegerLimit the number of Installs items returned per request.
pageIntegerPagination offset of the limited result set.
sortSortFields of LogInstalls followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

List of found 'install log' records that matched filter criteria.

Returns: array

Related Models

advertiser/stats/installs/find_export_queue Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fieldsArrayList of fields from the LogInstalls model desired in results. Defaults to display all fields.
formatStringjson, csv
backgroundBooleanIf true, then add job request to queue and run in background, else execute immediately.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Job identifier returned from queue and used for exporting results.

Returns: string

Related Models

advertiser/stats/ltv Controller

Advertiser Cohort Values (LTV) allows you to analyze your data byclick date time or install date time and see how those users (devices) performed over time.

advertiser/stats/ltv/count Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
interval (required)StringAny of the following supported values can be passed: year_day, year_week, year_month, year
cohort_type (required)String
aggregation_typeString
filterFilterFilter by fields and boolean operators against fields of the ReportingReport_Ltv model
fieldsArrayList of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields.
sortSortFields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport_Ltv model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/ltv/define Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArraySee the ReportingReport_Ltv model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/ltv/export Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
cohort_type (required)String
aggregation_type (required)String
intervalStringAny of the following supported values can be passed: year_day, year_week, year_month, year
filterFilterFilter by fields and boolean operators against fields of the ReportingReport_Ltv model
fieldsArrayList of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields.
sortSortFields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport_Ltv model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/ltv/find Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DateThe beginning datetime for the requested results.
end_date (required)DateThe end datetime for the requested results.
cohort_typeStringThe event - click or install - being used as the cohort factor.
aggregation_typeStringThe type of aggregation - cumulative or incremental - used to display the data.
intervalStringThe measurement of time (within your predefined time frame) you would like your chosen parameters to be grouped by. Any of the following supported values can be passed: year_day, year_week, year_month, year
filterFilterFilter by fields and boolean operators against fields of the ReportingReport_Ltv model
fieldsArrayList of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields.
limitIntegerLimit the number of ReportingReport_Ltv items returned per request.
pageInteger
sortSortFields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport_Ltv model.
formatStringjson, csv
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/ltv/status Method

Return status of export job

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
job_id (required)String
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

Related Models

advertiser/stats/postbacks Controller (deprecated)

advertiser/stats/postbacks/count Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the ConversionPostbacks model
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

The number of 'conversionpostback log' records matching filter criteria.

Returns: integer

Related Models

advertiser/stats/postbacks/define Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArrayList of related entities to include define data for. Set to * to get define data for all related entities. See the LogConversionPostbacks model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Details of entity 'advertiser/stats/postbacks' expressed as follows: {fields: {FIELD_NAME: {type: DATA_TYPE, auto_return: BOOLEAN, default: VALUE}} related_entities:{NAME: {endpoint: API_ENDPOINT}}}

Returns: object

Related Models

advertiser/stats/postbacks/find Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_dateDatetimeThe beginning datetime for the requested results.
end_dateDatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the ConversionPostbacks model
fieldsArrayList of fields from the ConversionPostbacks model desired in results. Defaults to display all fields.
limitIntegerLimit the number of ConversionPostbacks items returned per request.
pageIntegerPagination offset of the limited result set.
sortSortFields of ConversionPostbacks followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

List of found 'conversionpostback log' records that matched filter criteria.

Returns: array

Related Models

advertiser/stats/postbacks/find_export_queue Method

🚧

Deprecated

The v2 Reporting API for accessing log-level data has been deprecated. Customers are required to change their code to use the new v3 logs and exports endpoints.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
filterFilterFilter by fields and boolean operators against fields of the ConversionPostbacks model
fieldsArrayList of fields from the ConversionPostbacks model desired in results. Defaults to display all fields.
formatStringjson, csv
backgroundBooleanIf true, then add job request to queue and run in background, else execute immediately.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Job identifier returned from queue and used for exporting results.

Returns: string

Related Models

advertiser/stats/retention Controller

Advertiser Cohort Retention shows you how many of your installedusers open or engage with your app over time (how users continue to getvalue from the app).

advertiser/stats/retention/reduced Controller
advertiser/stats/retention/reduced/count Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
interval (required)StringAny of the following supported values can be passed: year_day, year_week, year_month, year
cohort_type (required)String
aggregation_typeString
filterFilterFilter by fields and boolean operators against fields of the ReportingReport_Retention model
fieldsArrayList of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields.
sortSortFields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport_Retention model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/retention/reduced/define Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
related_entitiesArraySee the ReportingReport_Retention model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/retention/reduced/export Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
cohort_type (required)String
intervalStringAny of the following supported values can be passed: year_day, year_week, year_month, year
filterFilterFilter by fields and boolean operators against fields of the ReportingReport_Retention model
fieldsArrayList of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields.
sortSortFields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport_Retention model.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/retention/reduced/find Method
名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
start_date (required)DatetimeThe beginning datetime for the requested results.
end_date (required)DatetimeThe end datetime for the requested results.
interval (required)StringAny of the following supported values can be passed: year_day, year_week, year_month, year
cohort_type (required)String
filterFilterFilter by fields and boolean operators against fields of the ReportingReport_Retention model
fieldsArrayList of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields.
limitIntegerLimit the number of ReportingReport_Retention items returned per request.
pageInteger
sortSortFields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions
groupArraySee the ReportingReport_Retention model.
formatStringjson, csv
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

Related Models

advertiser/stats/retention/reduced/status Method

Return status of export job

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
job_id (required)String
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

Related Models

export Controller

Export endpoints return report generation status and, once completed, a download link for your report.

📘

注意

Export endpoints can only be used to export records for the following reports:

To export logs data, use the Exports (v3) endpoints.

export/download Method

Get the current status of a report by job ID. Once the report has been processed completely, a download link is also returned.

名称类型描述
api_key (required)StringYour API Key; accessible on your User Details page of your Branch dashboard.
job_idStringReturned by ExportQueue.
response_timezone时区传达结果日期的时区;默认为您帐户中设置的时区。

GET Response Notes

Returns: array

exports Controller (v3)

Exports endpoints (v3) find and queue log records that match your search criteria for export. Like Logs, exports contain every single ad click, ad impression, app install, appopen, app event, app update, app event item and every postback sent on a per account basis.

Exports endpoints are limited to a maximum of 2 million records each. If more records are required, please make multiple requests withsmaller time intervals to pull the necessary data in "batches".

📘

注意

There are substantial differences between v2 and v3 of the Reporting API Log endpoints. Please reference the Migration Guide for more detail.

exports/clicks Method

Find and queue all LogClicks records that match search criteria for export. Returns a URL location for download of queued records for export.

Find and queue all LogClicks records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/event items Method

Find and queue all LogEventItems records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_idUrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_keyStringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_dateDateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_dateDateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fieldsComma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limitIntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/events Method

Find and queue all LogEvents records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/impressions Method

Find and queue all LogImpressions records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/installs Method

Find and queue all LogInstalls records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/opens Method

Find and queue all LogOpens records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/postbacks Method

Find and queue all LogConversionPostbacks records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

exports/updates Method

Find and queue all LogUpdates records that match search criteria for export. Returns a URL location for download of queued records for export.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 2million. If more than 2 million records are required, please makemultiple requests with smaller time intervals to pull the data needed in "batches".
response_formatNullable String响应格式;可以是 JSON 或 CSV。如果未选择,则默认为 CSV。

GET Response Notes

Returns a job handle and a pre-built URL location for download of queuedrecords for export. To build the download export URL yourself using the returned job handle, see exports/download exports.

Related Models

download exports Method

Finds and exports requested queue (by job_id) and provides URL location for download.

🚧

注意

This endpoint is rate limited at 480 requests per hour.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
job_id (required)UrlThe ID returned by the log export queue.

GET Response Notes

Status of the report on export queue and the report download linkin a JSON object or CSV matching your search criteria.

名称描述
statusPossible values: pending, running, complete, fail
urlThe URL from which you can download the export.
percent_completeIn v3, this value only returns 0 or 100, and will not show values in between. Use 'lines_exported' below for granular progress indication, and use percent_complete == 100 to determine when the export iscomplete. We recommend polling no more frequently than every 5-10minutes, otherwise, you may hit the maximum rate limit of 480 requestsper hour for the 'download' endpoint.
contextMessage containing information about the number of lines completed or errors.
lines_exportedNumber of lines currently exported. There is no way of predicting in advance how many lines an export will contain, but if this numbercontinues growing, the export is not yet finished.

logs Controller (v3)

Logs endpoints find and return log records that match your searchcriteria. Logs contain every single ad click, ad impression, appinstall, app open, app event, app update, app event item and everypostback sent on a per account basis.

Logs endpoints are limited to a 5000 record maximum and should not be used for export queries. To export log data, please use the applicable Exports endpoint.

📘

注意

There are substantial differences between v2 and v3 of the Reporting API Log endpoints. Please reference the Migration Guide for more detail.

logs/clicks Method

Retrieve all LogClicks records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogClicks model
fields (required)Comma Separated ListList of comma-separated fields from the LogClicks model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogClicks model followed by the direction (asc or desc). Results can be sorted with multiple fields and directions, separated by commas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogClicks records that matched search criteria.

Related Models

logs/event_items Method

Retrieve all LogEventItems records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogEventItems model
fields (required)Comma Separated ListList of comma-separated fields from the LogEventItems model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogEventItems model followed by the direction (asc or desc). Results can be sorted with multiple fields and directions, separated bycommas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogEventItems records that matched search criteria.

Related Models

logs/events Method

Retrieve all LogEvents records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterStringFilter by fields and boolean operators against fields of the LogEvents model.
fields (required)Comma Separated ListList of comma-separated fields from the LogEvents model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogEvents model followed by the direction (asc or desc). Results can be sorted with multiple fields and directions, separated by commas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogEvents records that matched search criteria.

Related Models

logs/impressions Method

Retrieves all LogImpressions records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogOpens model
fields (required)Comma Separated ListList of comma-separated fields from the LogOpens model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogOpens model followed by the direction (asc or desc). Resultscan be sorted with multiple fields and directions, separated by commas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogOpens records that matched search criteria.

Related Models

logs/installs Method

Retrieve all LogInstalls records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogInstalls model
fields (required)Comma Separated ListList of comma-separated fields from the LogInstalls model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogInstalls model followed by the direction (asc or desc). Results can be sorted with multiple fields and directions, separated bycommas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogInstalls records that matched search criteria.

Related Models

logs/opens Method

Retrieves all LogOpens records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogOpens model
fields (required)Comma Separated ListList of comma-separated fields from the LogOpens model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogOpens model followed by the direction (asc or desc). Resultscan be sorted with multiple fields and directions, separated by commas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogOpens records that matched search criteria.

Related Models

logs/postbacks Method

Retrieve all LogConversionPostbacks records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogConversionPostbacks model
fields (required)Comma Separated ListList of comma-separated fields from the LogConversionPostbacks model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogConversionPostbacks model followed by the direction (asc ordesc). Results can be sorted with multiple fields and directions, separated by commas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogConversionPostbacks records that matched search criteria.

Related Models

logs/updates Method

Retrieves all LogUpdates records that match search criteria.

名称类型描述
advertiser_id (required)UrlYour Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.
api_key (required)StringYour API Key; accessible via your User Details page of your Attribution Analytics account.
start_date (required)DateThe beginning datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date (required)DateThe end datetime for the requested results, provided in ISO-8601 format. Dates without offsets (i.e. a timezone) default to the value providedfor the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to the timezone set in your user account. If the timezone is not set in your user account, default is UTC. Example: 2016-01-01T23:59:59Z
时区时区Timezone for results. Accepts tz database strings like 'America/Los_Angeles'. Optional parameter; if not provided results default to timezone specific in your user account. If none isfound, results are returned in UTC.
filterFilterFilter by fields and boolean operators against fields of the LogOpens model
fields (required)Comma Separated ListList of comma-separated fields from the LogOpens model desired in results.
limit (required)IntegerLimit the number of items returned per request. Maximum allowed value is 5000.
sortsSortFields of the LogOpens model followed by the direction (asc or desc). Resultscan be sorted with multiple fields and directions, separated by commas. Example: site_id asc, created desc
response_formatNullable StringFormat of the response; can be either JSON or CSV. If not selected, defaults to JSON.

GET Response Notes

List of found LogOpens records that matched search criteria.

Related Models


这个页面对您有帮助吗?