Reporting API Controllers

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, and events measured for your mobile app at the time the end user generated them.

advertiser/stats/count Method

Get the count

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the StatAdvertiser model.

group

배열

List of identifier fields of 'advertiser stat' record to group results by. See the StatAdvertiser model.

timestamp

String

Set to breakdown stats by timestamp choices: hour, datehour, date, week, month

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/define Method

define

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

See the StatAdvertiser model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/find Method

Find stats

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the StatAdvertiser model.

fields

배열

List of fields from the StatAdvertiser model desired in results. Defaults to display all fields.

limit

정수

Limit the number of StatAdvertiser items returned per request.

page

정수

Pagination offset of the limited result set.

sort

정렬

Fields of StatAdvertiser followed by the direction (asc or desc). Results can be sorted with multiple fields and directions.

group

배열

List of identifier fields of 'advertiser stat' record to group results by. See the StatAdvertiser model.

timestamp

String

Set 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the StatAdvertiser model.

fields

배열

List of fields from the StatAdvertiser model desired in results. Defaults to display all fields.

group

배열

See the StatAdvertiser model.

timestamp

String

Set to breakdown stats by timestamp choices: hour, datehour, date, week, month

format

String

json, csv

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/status Method

Return status of export job

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

job_id (required)

String

None

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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport model

group

배열

See the ReportingReport model.

timestamp

String

Set to breakdown stats by timestamp choices: hour, datehour, date, week, month

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/actuals/define Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

See the ReportingReport model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/actuals/export Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport model

fields

배열

List of fields from the ReportingReport model desired in results. Defaults to display all fields.

sort

정렬

Fields of ReportingReport followed by the direction (asc or desc). Results can be sorted with multiple fields and directions

group

배열

See the ReportingReport model.

timestamp

String

Set to breakdown stats by timestamp choices: hour, datehour, date, week, month

format

String

json, csv

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/actuals/find Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport model

fields

배열

List of fields from the ReportingReport model desired in results. Defaults to display all fields.

limit

정수

Limit the number of ReportingReport items returned per request.

page

정수

None

sort

정렬

Fields of ReportingReport followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. See the ReportingReport model.

group

배열

See the ReportingReport model.

timestamp

String

Set to breakdown stats by timestamp choices: hour, datehour, date, week, month

format

String

json, csv

partner_selected_advertiser_id

정수

None

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/actuals/status Method

Return status of export job

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

job_id (required)

String

None

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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

See the ReportingReport model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/actuals/tmc/find Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

site_id (required)

정수

None

no_cache

불리안(Boolean)

None

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/actuals/tmc/status Method

Return status of export job

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

job_id (required)

String

None

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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter 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)

api_key (required)

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

List 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_key

String

Your API Key; accessible on your User Details page of your Branch dashboard

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogClicks model

fields

배열

List of fields from the LogClicks model desired in results. Defaults to display all fields.

limit

정수

Limit the number of Clicks items returned per request.

page

정수

Pagination offset of the limited result set.

sort

정렬

Fields 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_key

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogClicks model

fields

배열

List of fields from the LogClicks model desired in results. Defaults to display all fields.

format

String

json, csv

background

불리안(Boolean)

If 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

List 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogEventItems model

fields

배열

List of fields from the LogEventItems model desired in results. Defaults to display all fields.

limit

정수

Limit the number of LogEventItems items returned per request.

page

정수

Pagination offset of the limited result set.

sort

정렬

Fields 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogEventItems model

fields

배열

List of fields from the LogEventItems model desired in results. Defaults to display all fields.

format

String

json, csv

background

불리안(Boolean)

If 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

List 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogEvents model

fields

배열

List of fields from the LogEvents model desired in results. Defaults to display all fields.

limit

정수

Limit the number of Events items returned per request.

page

정수

Pagination offset of the limited result set.

sort

정렬

Fields 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogEvents model

fields

배열

List of fields from the LogEvents model desired in results. Defaults to display all fields.

format

String

json, csv

background

불리안(Boolean)

If 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

List 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields

배열

List of fields from the LogInstalls model desired in results. Defaults to display all fields. See the LogInstalls model.

limit

정수

Limit the number of Installs items returned per request.

page

정수

Pagination offset of the limited result set.

sort

정렬

Fields 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields

배열

List of fields from the LogInstalls model desired in results. Defaults to display all fields.

format

String

json, csv

background

불리안(Boolean)

If 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

interval (required)

String

Any of the following supported values can be passed: year_day, year_week, year_month, year

cohort_type (required)

String

None

aggregation_type

String

None

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport_Ltv model

fields

배열

List of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields.

sort

정렬

Fields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions.

group

배열

See the ReportingReport_Ltv model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/ltv/define Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

See the ReportingReport_Ltv model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/ltv/export Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

cohort_type (required)

String

None

aggregation_type (required)

String

None

interval

String

Any of the following supported values can be passed: year_day, year_week, year_month, year

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport_Ltv model

fields

배열

List of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields.

sort

정렬

Fields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions

group

배열

See the ReportingReport_Ltv model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/ltv/find Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

날짜

The beginning datetime for the requested results.

end_date (required)

날짜

The end datetime for the requested results.

cohort_type

String

The event - click or install - being used as the cohort factor.

aggregation_type

String

The type of aggregation - cumulative or incremental - used to display the data.

interval

String

The 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

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport_Ltv model

fields

배열

List of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields.

limit

정수

Limit the number of ReportingReport_Ltv items returned per request.

page

정수

None

sort

정렬

Fields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions

group

배열

See the ReportingReport_Ltv model.

format

String

son, csv

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/ltv/status Method

Return status of export job

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

job_id (required)

String

None

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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

List 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date

Datetime

The beginning datetime for the requested results.

end_date

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the ConversionPostbacks model

fields

배열

List of fields from the ConversionPostbacks model desired in results. Defaults to display all fields.

limit

정수

Limit the number of ConversionPostbacks items returned per request.

page

정수

Pagination offset of the limited result set.

sort

정렬

Fields 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)

String

String

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

filter

필터

Filter by fields and boolean operators against fields of the ConversionPostbacks model.

fields

배열

List of fields from the ConversionPostbacks model desired in results. Defaults to display all fields.

format

String

son, csv

background

불리안(Boolean)

If 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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

interval (required)

String

Any of the following supported values can be passed: year_day, year_week, year_month, year

cohort_type (required)

String

None

aggregation_type

String

None

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport_Retention model.

fields

배열

List of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields.

sort

정렬

Fields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions.

group

배열

See the ReportingReport_Retention model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/retention/reduced/define Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

related_entities

배열

See the ReportingReport_Retention model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

GET Response Notes

Returns: array|object

Related Models

advertiser/stats/retention/reduced/export Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

cohort_type (required)

String

None

interval

String

Any of the following supported values can be passed: year_day, year_week, year_month, year

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport_Retention model

fields

배열

List of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields.

sort

정렬

Fields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions.

group

배열

See the ReportingReport_Retention model.

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/retention/reduced/find Method

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

start_date (required)

Datetime

The beginning datetime for the requested results.

end_date (required)

Datetime

The end datetime for the requested results.

interval (required)

String

Any of the following supported values can be passed: year_day, year_week, year_month, year.

cohort_type (required)

String

None.

filter

필터

Filter by fields and boolean operators against fields of the ReportingReport_Retention model

fields

배열

List of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields.

limit

정수

Limit the number of ReportingReport_Retention items returned per request.

page

정수

None

sort

정렬

Fields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions

group

배열

See the ReportingReport_Retention model.

format

String

json, csv

response_timezone

시간대

결과 날짜가 전달되는 시간대로 기본값은 계정에 설정된 시간대입니다.

Related Models

advertiser/stats/retention/reduced/status Method

Return status of export job

이름

유형

설명

api_key (required)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

job_id (required)

String

None.

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.

📘

Note

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)

String

Your API Key; accessible on your User Details page of your Branch dashboard.

job_id

String

Returned 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".

📘

Note

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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

Nullable 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_id

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date

날짜

The 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

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit

정수

Limit 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_format

Nullable 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

Nullable 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

Nullable 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

Nullable 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

Nullable 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

Nullable 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields.

limit (required)

정수

Limit 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_format

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

🚧

Note

This endpoint is rate limited at 480 requests per hour.

이름

유형

설명

advertiser_id (required)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

job_id (required)

Url

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

이름

설명

status

Possible values: pending, running, complete, fail

URL

The URL from which you can download the export.

percent_complete

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

context

Message containing information about the number of lines completed or errors.

lines_exported

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

📘

Note

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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogClicks model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogClicks model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogEventItems model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogEventItems model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

String

Filter by fields and boolean operators against fields of the LogEvents model.

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogEvents model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogOpens model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogOpens model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogInstalls model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogInstalls model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogOpens model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogOpens model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogConversionPostbacks model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogConversionPostbacks model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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)

Url

Your Attribution Analytics Advertiser ID; accessible via the Advertiser Account Details page.

api_key (required)

String

Your API Key; accessible via your User Details page of your Attribution Analytics account.

start_date (required)

날짜

The 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)

날짜

The 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

시간대

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.

filter

필터

Filter by fields and boolean operators against fields of the LogOpens model

fields (required)

쉼표로 구분된 목록

List of comma-separated fields from the LogOpens model desired in results.

limit (required)

정수

Limit the number of items returned per request. Maximum allowed value is 5000.

sorts

정렬

Fields 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_format

Nullable String

Format 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