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, 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 | Filter by fields and boolean operators against fields of the StatAdvertiser model. |
group | Array | 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
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
advertiser/stats/define Method
define
名称 | 类型 | 描述 |
---|---|---|
api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
related_entities | Array | See the StatAdvertiser model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the StatAdvertiser model. |
fields | Array | List of fields from the StatAdvertiser model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of StatAdvertiser items returned per request. |
page | Integer | Pagination offset of the limited result set. |
sort | Sort | Fields of StatAdvertiser followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
group | Array | 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
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the StatAdvertiser model. |
fields | Array | List of fields from the StatAdvertiser model desired in results. Defaults to display all fields. |
group | Array | 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
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | 无 |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the ReportingReport model |
group | Array | See the ReportingReport model. |
timestamp | String | Set to breakdown stats by timestamp choices: hour, datehour, date, week, month |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
advertiser/stats/actuals/define Method
名称 | 类型 | 描述 |
---|---|---|
api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
related_entities | Array | See the ReportingReport model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array|object
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | Filter by fields and boolean operators against fields of the ReportingReport model |
fields | Array | List of fields from the ReportingReport model desired in results. Defaults to display all fields. |
sort | Sort | Fields of ReportingReport followed by the direction (asc or desc). Results can be sorted with multiple fields and directions |
group | Array | 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
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | Filter by fields and boolean operators against fields of the ReportingReport model |
fields | Array | List of fields from the ReportingReport model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of ReportingReport items returned per request. |
page | Integer | 无 |
sort | 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 | Array | 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 | Integer | 无 |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 无 |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | Array | See the ReportingReport model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array|object
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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) | Integer | 无 |
no_cache | Boolean | 无 |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 无 |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogClicks model |
fields | Array | List of fields from the LogClicks model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of Clicks items returned per request. |
page | Integer | Pagination offset of the limited result set. |
sort | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogClicks model |
fields | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | 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
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- SiteEventItems referenced as
site_event_item
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogEvents referenced as
stat_event
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Array | 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
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- SiteEventItems referenced as
site_event_item
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogEvents referenced as
stat_event
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogEventItems model |
fields | Array | List of fields from the LogEventItems model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of LogEventItems items returned per request. |
page | Integer | Pagination offset of the limited result set. |
sort | 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
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- SiteEventItems referenced as
site_event_item
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogEvents referenced as
stat_event
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogEventItems model |
fields | Array | 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
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- SiteEventItems referenced as
site_event_item
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogEvents referenced as
stat_event
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- Publishers referenced as
install_publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- LogInstalls referenced as
stat_install
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- Publishers referenced as
install_publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- LogInstalls referenced as
stat_install
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogEvents model |
fields | Array | List of fields from the LogEvents model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of Events items returned per request. |
page | Integer | Pagination offset of the limited result set. |
sort | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- Publishers referenced as
install_publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- LogInstalls referenced as
stat_install
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogEvents model |
fields | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- Publishers referenced as
install_publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- LogInstalls referenced as
stat_install
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields | Array | List of fields from the LogInstalls model desired in results. Defaults to display all fields. See the LogInstalls model. |
limit | Integer | Limit the number of Installs items returned per request. |
page | Integer | Pagination offset of the limited result set. |
sort | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | 无 |
aggregation_type | String | 无 |
filter | Filter | Filter by fields and boolean operators against fields of the ReportingReport_Ltv model |
fields | Array | List of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields. |
sort | Sort | Fields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
group | Array | See the ReportingReport_Ltv model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
advertiser/stats/ltv/define Method
名称 | 类型 | 描述 |
---|---|---|
api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
related_entities | Array | See the ReportingReport_Ltv model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array|object
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 无 |
aggregation_type (required) | String | 无 |
interval | String | Any of the following supported values can be passed: year_day, year_week, year_month, year |
filter | Filter | Filter by fields and boolean operators against fields of the ReportingReport_Ltv model |
fields | Array | List of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields. |
sort | Sort | Fields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions |
group | Array | See the ReportingReport_Ltv model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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) | Date | The beginning datetime for the requested results. |
end_date (required) | Date | 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 | Filter by fields and boolean operators against fields of the ReportingReport_Ltv model |
fields | Array | List of fields from the ReportingReport_Ltv model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of ReportingReport_Ltv items returned per request. |
page | Integer | 无 |
sort | Sort | Fields of ReportingReport_Ltv followed by the direction (asc or desc). Results can be sorted with multiple fields and directions |
group | Array | See the ReportingReport_Ltv model. |
format | String | son, csv |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 无 |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- Publishers referenced as
attributed_publisher
- LogConversionPostbacks referenced as
conversion_postback
- LogInstalls referenced as
stat_install
- LogEvents referenced as
stat_event
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- Publishers referenced as
attributed_publisher
- LogConversionPostbacks referenced as
conversion_postback
- LogInstalls referenced as
stat_install
- LogEvents referenced as
stat_event
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the ConversionPostbacks model |
fields | Array | List of fields from the ConversionPostbacks model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of ConversionPostbacks items returned per request. |
page | Integer | Pagination offset of the limited result set. |
sort | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- Publishers referenced as
attributed_publisher
- LogConversionPostbacks referenced as
conversion_postback
- LogInstalls referenced as
stat_install
- LogEvents referenced as
stat_event
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | Filter by fields and boolean operators against fields of the ConversionPostbacks model. |
fields | Array | 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
- Sites referenced as
site
- Publishers referenced as
publisher
- AdNetworks referenced as
ad_network
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- SiteEvents referenced as
site_event
- CampaignPayouts referenced as
campaign_payout
- Countries referenced as
country
- Regions referenced as
region
- Publishers referenced as
attributed_publisher
- LogConversionPostbacks referenced as
conversion_postback
- LogInstalls referenced as
stat_install
- LogEvents referenced as
stat_event
- LogClicks referenced as
stat_click
- TestProfiles referenced as
test_profile
- Agencies referenced as
agency
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 | 无 |
aggregation_type | String | 无 |
filter | Filter | Filter by fields and boolean operators against fields of the ReportingReport_Retention model. |
fields | Array | List of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields. |
sort | Sort | Fields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
group | Array | See the ReportingReport_Retention model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | Array | See the ReportingReport_Retention model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
GET
Response Notes
Returns: array|object
Related Models
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | 无 |
interval | String | Any of the following supported values can be passed: year_day, year_week, year_month, year |
filter | Filter | Filter by fields and boolean operators against fields of the ReportingReport_Retention model |
fields | Array | List of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields. |
sort | Sort | Fields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
group | Array | See the ReportingReport_Retention model. |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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 | Filter by fields and boolean operators against fields of the ReportingReport_Retention model |
fields | Array | List of fields from the ReportingReport_Retention model desired in results. Defaults to display all fields. |
limit | Integer | Limit the number of ReportingReport_Retention items returned per request. |
page | Integer | 无 |
sort | Sort | Fields of ReportingReport_Retention followed by the direction (asc or desc). Results can be sorted with multiple fields and directions |
group | Array | See the ReportingReport_Retention model. |
format | String | json, csv |
response_timezone | 时区 | 传达结果日期的时区;默认为您帐户中设置的时区。 |
Related Models
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
- Advertisers referenced as
advertiser
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
- Publishers referenced as
publisher
- Sites referenced as
site
- SiteEvents referenced as
site_event
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Regions referenced as
region
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- TestProfiles referenced as
test_profile
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) | 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".
注意
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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 | 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 | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEventItems referenced as
site_event_item
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
publisher
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Advertisers referenced as
advertiser
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- CampaignUrls referenced as
campaign_url
- Campaigns referenced as
campaign
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Publishers referenced as
publisher
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Advertisers referenced as
advertiser
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- CampaignUrls referenced as
campaign_url
- Campaigns referenced as
campaign
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Publishers referenced as
publisher
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
attributed_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
publisher
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. Defaults to display all fields. |
limit (required) | Integer | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Advertisers referenced as
advertiser
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- CampaignUrls referenced as
campaign_url
- Campaigns referenced as
campaign
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Publishers referenced as
publisher
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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.
注意
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogClicks model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogClicks model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
install_publisher
- SiteEvents referenced as
site_event
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogEventItems model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogEventItems model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEventItems referenced as
site_event_item
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
install_publisher
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) | 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 (required) | 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 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) | Comma Separated List | List of comma-separated fields from the LogEvents model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
publisher
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogOpens model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogOpens model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Advertisers referenced as
advertiser
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- CampaignUrls referenced as
campaign_url
- Campaigns referenced as
campaign
- Countries referenced as
country
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Publishers referenced as
publisher
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogInstalls model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogInstalls model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
install_publisher
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogOpens model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogOpens model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Advertisers referenced as
advertiser
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- CampaignUrls referenced as
campaign_url
- Campaigns referenced as
campaign
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Publishers referenced as
publisher
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogConversionPostbacks model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogConversionPostbacks model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- Campaigns referenced as
campaign
- CampaignUrls referenced as
campaign_url
- Countries referenced as
country
- Publishers referenced as
attributed_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
- Publishers referenced as
publisher
- Advertisers referenced as
advertiser
- LogConversionPostbacks referenced as
conversion_postback
- SiteEventItems referenced as
site_event_item
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) | 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 (required) | 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 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 | Filter by fields and boolean operators against fields of the LogOpens model |
fields (required) | Comma Separated List | List of comma-separated fields from the LogOpens model desired in results. |
limit (required) | Integer | Limit the number of items returned per request. Maximum allowed value is 5000. |
sorts | Sort | 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
- AdNetworks referenced as
ad_network
- AdvertiserSubAdgroups referenced as
advertiser_sub_adgroup
- AdvertiserSubAds referenced as
advertiser_sub_ad
- AdvertiserSubCampaigns referenced as
advertiser_sub_campaign
- AdvertiserSubKeywords referenced as
advertiser_sub_keyword
- AdvertiserSubPlacements referenced as
advertiser_sub_placement
- AdvertiserSubPublishers referenced as
advertiser_sub_publisher
- AdvertiserSubSites referenced as
advertiser_sub_site
- Advertisers referenced as
advertiser
- Agencies referenced as
agency
- CampaignPayouts referenced as
campaign_payout
- CampaignUrls referenced as
campaign_url
- Campaigns referenced as
campaign
- Countries referenced as
country
- Publishers referenced as
install_publisher
- PublisherSubAdgroups referenced as
publisher_sub_adgroup
- PublisherSubAds referenced as
publisher_sub_ad
- PublisherSubCampaigns referenced as
publisher_sub_campaign
- PublisherSubKeywords referenced as
publisher_sub_keyword
- PublisherSubPlacements referenced as
publisher_sub_placement
- PublisherSubPublishers referenced as
publisher_sub_publisher
- PublisherSubSites referenced as
publisher_sub_site
- Publishers referenced as
publisher
- Regions referenced as
region
- SiteEvents referenced as
site_event
- Sites referenced as
site
- TestProfiles referenced as
test_profile
Updated 8 months ago