Management API Controllers
account Controller
Your account defines the profile of either an individual or a company that has access to TUNE services.
account/count Method
Count 'account' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Accounts model. |
GET Response Notes
The number of 'account' records matching filter.
Returns: integer
Related Models
- Countries referenced as
country - Regions referenced as
region - Agencies referenced as
agencies - Advertisers referenced as
advertisers - Publishers referenced as
publishers
account/find Method
Find all 'account' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Accounts model. |
| fields | Array | List of fields from the Accounts model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Accounts items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Accounts followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'account' records that matched filter criteria.
Returns: array
Related Models
- Countries referenced as
country - Regions referenced as
region - Agencies referenced as
agencies - Advertisers referenced as
advertisers - Publishers referenced as
publishers
account/get_current Method
Get the current account for the current user / context.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| fields | Array | List of fields from the Accounts model desired in results. Defaults to display all fields. |
GET Response Notes
object
Returns: RecordsModelAccounts
Related Models
- Countries referenced as
country - Regions referenced as
region - Agencies referenced as
agencies - Advertisers referenced as
advertisers - Publishers referenced as
publishers
account/test_profiles Controller
With a test profile, you can test for proper measurement & attribution functionality repeatedly with the same device.
account/test_profiles/count Method
Count 'testprofile' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the TestProfiles model. |
GET Response Notes
The number of 'testprofile' records matching filter.
Returns: integer
account/test_profiles/find Method
Find all 'testprofile' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the TestProfiles model. |
| fields | Array | List of fields from the TestProfiles model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of TestProfiles items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of TestProfiles followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'testprofile' records that matched filter criteria.
Returns: array
account/users Controller
account/users/check_password_strength Method
Check password strength
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| password (required) | String | None |
GET Response Notes
Returns: bool
account/users/count Method
Count 'user' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Users model. |
GET Response Notes
The number of 'user' records matching filter.
Returns: integer
account/users/find Method
Find all 'user' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Users model. |
| fields | Array | List of fields from the Users model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Users items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Users followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'user' records that matched filter criteria.
Returns: array
account/users/get_current Method
Get the current user.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| fields | Array | List of fields from the Users model desired in results. Defaults to display all fields. |
GET Response Notes
object
Returns: user
account/users/get_two_factor_auth Method
Generate a new Google Auth code
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
GET Response Notes
Returns: object
account/users/verify_two_factor_auth Method
Verify Google Auth Code works and enable
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| code (required) | String | None |
GET Response Notes
Returns: boolean
account/users/password Controller
account/users/password/check_strength Method
Check the strength - either weak or strong - of the user's password.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| password (required) | String | None |
| first_name | String | None |
| last_name | String | None |
| String | None |
GET Response Notes
True if strong password
Returns: bool
advertiser Controller
Advertisers are the entities offering products or services to consumers over the (desktop or mobile) web or via a mobile app.
advertiser/count Method
Count 'advertiser' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Advertisers model. |
GET Response Notes
The number of 'advertiser' records matching filter.
Returns: integer
Related Models
- Accounts referenced as
account - Sites referenced as
sites - Campaigns referenced as
campaigns - Countries referenced as
country - Regions referenced as
region - ConversionKeys referenced as
conversion_key - Agencies referenced as
agency - AdvertiserAgencies referenced as
agency_relationships
advertiser/find Method
Find all 'advertiser' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Advertisers model. |
| fields | Array | List of fields from the Advertisers model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Advertisers items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Advertisers followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'advertiser' records that matched filter criteria.
Returns: array
Related Models
- Accounts referenced as
account - Sites referenced as
sites - Campaigns referenced as
campaigns - Countries referenced as
country - Regions referenced as
region - ConversionKeys referenced as
conversion_key - Agencies referenced as
agency - AdvertiserAgencies referenced as
agency_relationships
advertiser/get_current Method
Get the current account for the current user / context.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| fields | Array | List of fields from the Advertisers model desired in results. Defaults to display all fields. |
GET Response Notes
object
Returns: account
Related Models
- Accounts referenced as
account - Sites referenced as
sites - Campaigns referenced as
campaigns - Countries referenced as
country - Regions referenced as
region - ConversionKeys referenced as
conversion_key - Agencies referenced as
agency - AdvertiserAgencies referenced as
agency_relationships
advertiser/ad_networks Controller
Ad networks are companies that aggregate inventory from many publishers (large and small) and align it with advertiser demand.
advertiser/ad_networks/count Method
Count 'adnetwork' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdNetworks model. |
GET Response Notes
The number of 'adnetwork' records matching filter.
Returns: integer
Related Models
- Publishers referenced as
publishers
advertiser/ad_networks/find Method
Find all 'adnetwork' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdNetworks model. |
| fields | Array | List of fields from the AdNetworks model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of AdNetworks items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of AdNetworks followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'adnetwork' records that matched filter criteria.
Returns: array
Related Models
- Publishers referenced as
publishers
advertiser/ad_networks/credentials Controller
advertiser/ad_networks/credentials/count Method
Count 'publishercredential' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherCredentials model. |
GET Response Notes
The number of 'publishercredential' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/ad_networks/credentials/find Method
Find all 'publishercredential' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherCredentials model. |
| fields | Array | List of fields from the PublisherCredentials model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of PublisherCredentials items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of PublisherCredentials followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'publishercredential' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/ad_networks/data_sharing Controller
advertiser/ad_networks/data_sharing/count Method
Count 'advertiseradnetworkdatasharing' records by filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserAdNetworkDataSharing model. |
GET Response Notes
The number of 'advertiseradnetworkdatasharing' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/ad_networks/data_sharing/find Method
Find all 'advertiseradnetworkdatasharing' records matching
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserAdNetworkDataSharing model. |
| fields | Array | List of fields from the AdvertiserAdNetworkDataSharing model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of AdvertiserAdNetworkDataSharing items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of AdvertiserAdNetworkDataSharing followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'advertiseradnetworkdatasharing' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/ad_networks/stats Controller
Provides access to ad network stats. Aggregation is done on the ad network level based on the provided filters.
advertiser/ad_networks/stats/find Method
Return Ad Network Stats
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter by fields and boolean operators against fields of the AdNetworkStats model. | |
| fields | Array | List of fields from the AdNetworkStats model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of AdNetworkStats items returned per request. |
| page | Integer | The page of results to return. |
| sort | Sort | Fields of AdNetworkstats followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
| countries | Array | List of country ids to filter by. |
| geos | Array | List of geo ids to filter by. |
GET Response Notes
'advertiser/ad_networks/stats' entities
Returns: array
Related Models
- AdNetworks referenced as
ad_network
advertiser/agencies Controller
An advertising agency - full access or limited - creates, plans and handles the advertising of your mobile apps for you.
advertiser/agencies/count Method
Count 'advertiseragency' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserAgencies model. |
GET Response Notes
The number of 'advertiseragency' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser - Agencies referenced as
agency
advertiser/agencies/find Method
Find all 'advertiseragency' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserAgencies model |
| fields | Array | List of fields from the AdvertiserAgencies model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of AdvertiserAgencies items returned per request |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of AdvertiserAgencies followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'advertiseragency' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser - Agencies referenced as
agency
advertiser/campaigns Controller
Campaigns are a management layer in Attribution Analytics between your mobile app and your publishers. A campaign helps you manage multiple publisher relationships.
advertiser/campaigns/count Method
Count 'campaign' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Campaigns model. |
GET Response Notes
The number of 'campaign' records matching filter.
Returns: integer
Related Models
- Sites referenced as
site - CampaignUrls referenced as
urls - CampaignPayouts referenced as
payouts - Publishers referenced as
publishers
advertiser/campaigns/find Method
Find all 'campaign' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Campaigns model. |
| fields | Array | List of fields from the Campaigns model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Campaigns items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Campaigns followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'campaign' records that matched filter criteria.
Returns: array
Related Models
- Sites referenced as
site - CampaignUrls referenced as
urls - CampaignPayouts referenced as
payouts - Publishers referenced as
publishers
advertiser/campaigns/pause_campaign Method
Pause a campaign.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| id | Integer | None |
GET Response Notes
Returns: object
Related Models
- Sites referenced as
site - CampaignUrls referenced as
urls - CampaignPayouts referenced as
payouts - Publishers referenced as
publishers
advertiser/campaigns/invoke_urls Controller
The functionality to first detect if a user is an existing user or not (i.e. already has the app in question installed) and to then open and redirect the user to said app via an invoke URL, otherwise known as 'deep linking', rather than redirecting them to the app store to download the app.
advertiser/campaigns/invoke_urls/count Method
Count 'campaigninvokeurl' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the CampaignInvokeUrls model. |
GET Response Notes
The number of 'campaigninvokeurl' records matching filter.
Returns: integer
Related Models
- Campaigns referenced as
campaign
advertiser/campaigns/invoke_urls/find Method
Find all 'campaigninvokeurl' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the CampaignInvokeUrls model. |
| fields | Array | List of fields from the CampaignInvokeUrls model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of CampaignInvokeUrls items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of CampaignInvokeUrls followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'campaigninvokeurl' records that matched filter criteria.
Returns: array
Related Models
- Campaigns referenced as
campaign
advertiser/campaigns/payouts Controller
The payout for a publisher on the campaign which is associated to the mobile app.
advertiser/campaigns/payouts/count Method
Count 'campaignpayout' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the CampaignPayouts model. |
GET Response Notes
The number of 'campaignpayout' records matching filter.
Returns: integer
Related Models
- Publishers referenced as
publisher - Campaigns referenced as
campaign - SiteEvents referenced as
site_event
advertiser/campaigns/payouts/find Method
Find all 'campaignpayout' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the CampaignPayouts model. |
| fields | Array | List of fields from the CampaignPayouts model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of CampaignPayouts items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of CampaignPayouts followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'campaignpayout' records that matched filter criteria.
Returns: array
Related Models
- Publishers referenced as
publisher - Campaigns referenced as
campaign - SiteEvents referenced as
site_event
advertiser/campaigns/urls Controller
Destination URL address for a campaign used to determine where people are taken when they click ad.
advertiser/campaigns/urls/count Method
Count 'campaignurl' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the CampaignUrls model. |
GET Response Notes
The number of 'campaignurl' records matching filter.
Returns: integer
advertiser/campaigns/urls/countries_get Method
Returns the list of country ids this URL is to be shown to
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| id (required) | Integer | None |
GET Response Notes
country_ids
Returns: array
Related Models
advertiser/campaigns/urls/countries_set Method
Saves the list of country ids this URL is to be shown to
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| id (required) | Integer | None |
| countries (required) | Array | None |
GET Response Notes
country_ids
Returns: array
Related Models
advertiser/campaigns/urls/find Method
Find all 'campaignurl' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the CampaignUrls model. |
| fields | Array | List of fields from the CampaignUrls model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of CampaignUrls items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of CampaignUrls followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'campaignurl' records that matched filter criteria.
Returns: array
Related Models
advertiser/data_sharing Controller
Set default events for your postback URLs at an account level that "pre-populate" each time you add a partner (added partners will automatically receive postback notifications for the default events that you select).
advertiser/data_sharing/bulk_save Method
Incoming array of event types represents the final "view" of
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| event_types (required) | Array | None |
GET Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser
advertiser/data_sharing/count Method
Count 'advertiserdatasharing' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserDataSharing model. |
GET Response Notes
The number of 'advertiserdatasharing' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser
advertiser/data_sharing/enable_ad_network Method
EnableAdNetworks updates advertiser_ad_network_data_sharing
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| ad_network_id (required) | Integer | None |
GET Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser
advertiser/data_sharing/find Method
Find all 'advertiserdatasharing' records matching provided
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserDataSharing model. |
| fields | Array | List of fields from the AdvertiserDataSharing model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of AdvertiserDataSharing items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of AdvertiserDataSharing followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'advertiserdatasharing' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser
advertiser/data_sharing/preferences Method
Return an array of event_type => bool to reflect the
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
Related Models
- Advertisers referenced as
advertiser
advertiser/measurement_urls Controller
A user clicking a measurement URL is the primary mechanism for initiating a measurement session in Attribution Analytics. The click is then associated with a subsequent install (or in-app event) and is attributed to the ad network or publisher responsible for influencing the user to install the mobile app (or perform an in-app event).
advertiser/measurement_urls/count Method
Count 'measurementurl' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the MeasurementUrls model. |
GET Response Notes
The number of 'measurementurl' records matching filter.
Returns: integer
Related Models
- Sites referenced as
sites - Publishers referenced as
publisher - Advertisers referenced as
advertiser - Agencies referenced as
agency - Campaigns referenced as
campaign - CampaignUrls referenced as
campaign_url - CampaignInvokeUrls referenced as
campaign_invoke_url
advertiser/measurement_urls/find Method
Find all 'measurementurl' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the MeasurementUrls model. |
| fields | Array | List of fields from the MeasurementUrls model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of MeasurementUrls items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of MeasurementUrls followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'measurementurl' records that matched filter criteria.
Returns: array
advertiser/measurement_urls/get_tracking_urls Method
Endpoint to generate the base URL and parameters
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| publisher_id (required) | Integer | None |
| site_id (required) | Integer | None |
| protocol (required) | String | None |
GET Response Notes
{clicks:url,impressions:url}
Returns: array
Related Models
- Sites referenced as
sites - Publishers referenced as
publisher - Advertisers referenced as
advertiser - Agencies referenced as
agency - Campaigns referenced as
campaign - CampaignUrls referenced as
campaign_url - CampaignInvokeUrls referenced as
campaign_invoke_url
advertiser/measurement_urls/defaults Controller
Instead of manually setting such parameters every time at the partner level, you can set defaults for your measurement URLs at an account level that "pre-populate" each time you go to create a measurement URL (then you can modify these defaults for each partner, if applicable).
advertiser/measurement_urls/defaults/count Method
Count 'measurementurldefault' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the MeasurementUrlDefaults model. |
GET Response Notes
The number of 'measurementurldefault' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser - Publishers referenced as
publisher
advertiser/measurement_urls/defaults/find Method
Find all 'measurementurldefault' records matching provided
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the MeasurementUrlDefaults model. |
| fields | Array | List of fields from the MeasurementUrlDefaults model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of MeasurementUrlDefaults items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of MeasurementUrlDefaults followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'measurementurldefault' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser - Publishers referenced as
publisher
advertiser/publishers Controller
Publishers are the producers of sites that display digital content for the consumer audience. Advertiser products or services are promoted on publisher sites.
advertiser/publishers/campaign_url_tracking_code Method
Gets a tracking code for advertiser to give to publisher to
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| id (required) | Integer | Publisher id to get tracking code for. |
| destination_id (required) | Integer | Destination url id to get tracking code for. |
| invoke_id | Integer | Invoke url id to get tracking code for. |
| options | Array of structured objects | None |
GET Response Notes
Info to give to publisher (click_url, impression_pixel as well as info about adgroup this connected to)
Returns: array
Related Models
- Accounts referenced as
account - AdNetworks referenced as
ad_network
advertiser/publishers/campaign_url_tracking_code_for_ad_network Method
Create the tracking code and does setup needed to connect to
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| destination_id (required) | Integer | None |
| ad_network_id (required) | Integer | None |
| invoke_id | Integer | None |
| options | Array of structured objects | None |
GET Response Notes
Info to give to publisher (click_url, impression_pixel as well as info about adgroup this connected to)
Returns: array
Related Models
- Accounts referenced as
account - AdNetworks referenced as
ad_network
advertiser/publishers/count Method
Count 'publisher' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Publishers model. |
GET Response Notes
The number of 'publisher' records matching filter.
Returns: integer
Related Models
- Accounts referenced as
account - AdNetworks referenced as
ad_network
advertiser/publishers/create Method
Creates a new internal publisher that belongs to current
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| name (required) | String | None |
GET Response Notes
'advertiser/publishers' entity
Returns: array
Related Models
- Accounts referenced as
account - AdNetworks referenced as
ad_network
advertiser/publishers/find Method
Find all the 'advertiser/publishers' objects by filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the Publishers model. |
| fields | Array | List of fields from the Publishers model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Publishers items returned per request. |
| page | Integer | The page of results to return. |
| sort | Sort | Fields of Publishers followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
'advertiser/publishers' entities
Returns: array
Related Models
- Accounts referenced as
account - AdNetworks referenced as
ad_network
advertiser/publishers/event_notifications Controller
Publisher notifications about installs and/or other events.
advertiser/publishers/event_notifications/count Method
Count 'publishereventnotification' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherEventNotifications model. |
GET Response Notes
The number of 'publishereventnotification' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser - Publishers referenced as
publisher - Sites referenced as
site - SiteEvents referenced as
site_event - Campaigns referenced as
campaign - CampaignPayouts referenced as
campaign_payout - AdNetworks referenced as
ad_network - AdNetworkPostbacks referenced as
ad_network_postback - AdNetworkPreferenceValues referenced as
ad_network_preference_values - PublisherSubPublishers referenced as
publisher_sub_publisher - Agencies referenced as
agency
advertiser/publishers/event_notifications/find Method
Find all 'publishereventnotification' records matching provided
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherEventNotifications model. |
| fields | Array | List of fields from the PublisherEventNotifications model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of PublisherEventNotifications items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of PublisherEventNotifications followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'publishereventnotification' records that matched filter criteria.
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 - CampaignPayouts referenced as
campaign_payout - AdNetworks referenced as
ad_network - AdNetworkPostbacks referenced as
ad_network_postback - AdNetworkPreferenceValues referenced as
ad_network_preference_values - PublisherSubPublishers referenced as
publisher_sub_publisher - Agencies referenced as
agency
advertiser/publishers/event_notifications/code_values Controller
advertiser/publishers/event_notifications/code_values/bulk_save Method
Bulk save many code/value pairs for an ad_network_id
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| data (required) | Object | None |
GET Response Notes
Returns: array
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/publishers/event_notifications/code_values/count Method
Count 'publishereventnotificationcodevalue' records by filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherEventNotificationCodeValues model. |
GET Response Notes
The number of 'publishereventnotificationcodevalue' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/publishers/event_notifications/code_values/find Method
Find all 'publishereventnotificationcodevalue' records matching
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherEventNotificationCodeValues model. |
| fields | Array | List of fields from the PublisherEventNotificationCodeValues model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of PublisherEventNotificationCodeValues items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of PublisherEventNotificationCodeValues followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'publishereventnotificationcodevalue' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser - AdNetworks referenced as
ad_network
advertiser/publishers/urls Controller
A server postback is a URL request to a third-party system that notifies them of a conversion (typically an install). You can set up postback URLs for each publisher on all mobile apps (a global postback URL) or you can add the postback URL for a single mobile app.
advertiser/publishers/urls/count Method
Count 'publisherurl' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherUrls model. |
GET Response Notes
The number of 'publisherurl' records matching filter.
Returns: integer
Related Models
- Publishers referenced as
publisher - AdNetworks referenced as
ad_network - Advertisers referenced as
advertiser - Sites referenced as
site - Campaigns referenced as
campaign - CampaignUrls referenced as
campaign_url - CampaignInvokeUrls referenced as
campaign_invoke_url - PublisherSubPublishers referenced as
publisher_sub_publisher - PublisherSubSites referenced as
publisher_sub_site - PublisherSubCampaigns referenced as
publisher_sub_campaign - 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 - AdvertiserSubAds referenced as
advertiser_sub_ad - AdvertiserSubKeywords referenced as
advertiser_sub_keyword - AdvertiserSubPlacements referenced as
advertiser_sub_placement
advertiser/publishers/urls/find Method
Find all 'publisherurl' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the PublisherUrls model. |
| fields | Array | List of fields from the PublisherUrls model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of PublisherUrls items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of PublisherUrls followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'publisherurl' records that matched filter criteria.
Returns: array
Related Models
- Publishers referenced as
publisher - AdNetworks referenced as
ad_network - Advertisers referenced as
advertiser - Sites referenced as
site - Campaigns referenced as
campaign - CampaignUrls referenced as
campaign_url - CampaignInvokeUrls referenced as
campaign_invoke_url - PublisherSubPublishers referenced as
publisher_sub_publisher - PublisherSubSites referenced as
publisher_sub_site - PublisherSubCampaigns referenced as
publisher_sub_campaign - 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 - AdvertiserSubAds referenced as
advertiser_sub_ad - AdvertiserSubKeywords referenced as
advertiser_sub_keyword - AdvertiserSubPlacements referenced as
advertiser_sub_placement
advertiser/report_schedule Controller
Reports can be set up to run on all report types, with various fields/filters/sorts with differeing time intervals.
advertiser/report_schedule/count Method
Count 'reportschedule' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the ReportSchedule model. |
GET Response Notes
The number of 'reportschedule' records matching filter.
Returns: integer
Related Models
- Schedule referenced as
schedule
advertiser/report_schedule/create Method
Creates a scheduled report (also creates a schedule)
| Name | Type | Description |
|---|---|---|
| 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. |
| schedule_interval (required) | String | None |
| name (required) | String | None |
| range (required) | String | None |
| report_type (required) | String | None |
| report_id (required) | Integer | None |
| cohort_type | String | None |
| aggregation_type | String | None |
| time_to_run | Time | None |
| scheduled_day | Integer | None |
| interval | String | None |
| filter | Filter | Filter by fields and boolean operators against fields of the ReportSchedule model. |
| fields | Array | List of fields from the ReportSchedule model desired in results. Defaults to display all fields. |
| sort | Sort | Fields of ReportSchedule followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
| group | Array | None |
| timestamp | String | None |
GET Response Notes
Returns: void
Related Models
- Schedule referenced as
schedule
advertiser/report_schedule/find Method
Find all 'reportschedule' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the ReportSchedule model. |
| fields | Array | List of fields from the ReportSchedule model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of ReportSchedule items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of ReportSchedule followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'reportschedule' records that matched filter criteria.
Returns: array
Related Models
- Schedule referenced as
schedule
advertiser/s3_logs Controller
To log click and installation events from TUNE to a custom Amazon S3 bucket (directory) in your Amazon Web Services (AWS) account, you can query the API to retrieve a list of log files and their download links.
advertiser/s3_logs/count Method
Count 'advertisers3log' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserS3Logs model. |
GET Response Notes
The number of 'advertisers3log' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertiser
advertiser/s3_logs/find Method
Find all 'advertisers3log' records matching provided filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the AdvertiserS3Logs model. |
| fields | Array | List of fields from the AdvertiserS3Logs model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of AdvertiserS3Logs items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of AdvertiserS3Logs followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'advertisers3log' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertiser
advertiser/s3_logs/get_current Method
Get the current credentials for the current advertiser
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| fields | Array | List of fields from the AdvertiserS3Logs model desired in results. Defaults to display all fields. |
GET Response Notes
object
Returns: account
Related Models
- Advertisers referenced as
advertiser
advertiser/s3_logs/validate_credentials Method
Validates that the access_key/secret key work and have
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
GET Response Notes
Returns: boolean
Related Models
- Advertisers referenced as
advertiser
advertiser/sites Controller
The device-specific profile of a site; your mobile app.
advertiser/sites/count Method
Count 'site' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Sites model. |
GET Response Notes
The number of 'site' records matching filter.
Returns: integer
Related Models
- SiteEvents referenced as
site_events - Campaigns referenced as
campaigns - ConversionKeys referenced as
conversion_key
advertiser/sites/event_web_tracking_urls Method
Gets tracking urls for site events
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| site_id (required) | Integer | Site id to get tracking code for. |
| options | Array of structured objects | None |
GET Response Notes
Returns: array
Related Models
- SiteEvents referenced as
site_events - Campaigns referenced as
campaigns - ConversionKeys referenced as
conversion_key
advertiser/sites/find Method
Find all 'site' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Sites model. |
| fields | Array | List of fields from the Sites model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Sites items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Sites followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'site' records that matched filter criteria.
Returns: array
Related Models
- SiteEvents referenced as
site_events - Campaigns referenced as
campaigns - ConversionKeys referenced as
conversion_key
advertiser/sites/logo_delete Method
Delete the logo for this site
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| site_id (required) | Integer | None |
GET Response Notes
Returns: boolean
Related Models
- SiteEvents referenced as
site_events - Campaigns referenced as
campaigns - ConversionKeys referenced as
conversion_key
advertiser/sites/logo_upload Method
Upload logo for an app
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| site_id (required) | Integer | None |
| data (required) | Object | None |
GET Response Notes
Returns: bool|object
Related Models
- SiteEvents referenced as
site_events - Campaigns referenced as
campaigns - ConversionKeys referenced as
conversion_key
advertiser/sites/events Controller
The event associated with the install of a site (mobile app).
advertiser/sites/events/count Method
Count 'siteevent' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the SiteEvents model. |
GET Response Notes
The number of 'siteevent' records matching filter.
Returns: integer
Related Models
- Sites referenced as
site - CampaignPayouts referenced as
payouts
advertiser/sites/events/find Method
Find all 'siteevent' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the SiteEvents model. |
| fields | Array | List of fields from the SiteEvents model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of SiteEvents items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of SiteEvents followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'siteevent' records that matched filter criteria.
Returns: array
Related Models
- Sites referenced as
site - CampaignPayouts referenced as
payouts
advertiser/sites/events/get_with_tracking Method
Same as parent::get() but adds tracking url if
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| id (required) | Integer | None |
| fields | Array | List of fields from the SiteEvents model desired in results. Defaults to display all fields. |
| options | Array of structured objects | None |
GET Response Notes
Returns: array|mixed|Returns
Related Models
- Sites referenced as
site - CampaignPayouts referenced as
payouts
advertiser/sites/events/web_tracking_url Method
Gets tracking url for site event
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| site_event_id | Integer | Site Event id to get tracking code for. |
| options | Array of structured objects | None. |
GET Response Notes
Returns: array
Related Models
- Sites referenced as
site - CampaignPayouts referenced as
payouts
agency Controller
An advertising agency - full access or limited - creates, plans and handles the advertising of your mobile apps for you.
agency/count Method
Count 'agency' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Agencies model. |
GET Response Notes
The number of 'agency' records matching filter.
Returns: integer
Related Models
- Accounts referenced as
account - Users referenced as
primary_contact_user - Users referenced as
users - Advertisers referenced as
advertisers - AdvertiserAgencies referenced as
advertiser_relationships
agency/find Method
Find all 'agency' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Agencies model. |
| fields | Array | List of fields from the Agencies model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Agencies items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Agencies followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'agency' records that matched filter criteria.
Returns: array
Related Models
- Accounts referenced as
account - Users referenced as
primary_contact_user - Users referenced as
users - Advertisers referenced as
advertisers - AdvertiserAgencies referenced as
advertiser_relationships
agency/get_current Method
Get the current account for the current user / context.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| fields | Array | List of fields from the Agencies model desired in results. Defaults to display all fields. |
GET Response Notes
object
Returns: account
Related Models
- Accounts referenced as
account - Users referenced as
primary_contact_user - Users referenced as
users - Advertisers referenced as
advertisers - AdvertiserAgencies referenced as
advertiser_relationships
agency/accounts Controller
Your account defines the profile of either an individual or a company that has access to TUNE services.
agency/accounts/count Method
Count 'account' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Accounts model. |
GET Response Notes
The number of 'account' records matching filter.
Returns: integer
Related Models
- Countries referenced as
country - Regions referenced as
region - Users referenced as
users - Advertisers referenced as
advertisers - Publishers referenced as
publishers - Agencies referenced as
agencies
agency/accounts/find Method
Find all 'account' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Accounts model. |
| fields | Array | List of fields from the Accounts model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Accounts items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Accounts followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'account' records that matched filter criteria.
Returns: array
Related Models
- Countries referenced as
country - Regions referenced as
region - Users referenced as
users - Advertisers referenced as
advertisers - Publishers referenced as
publishers - Agencies referenced as
agencies
agency/accounts/users Controller
Defines profile of users connected to any given TUNE account.
agency/accounts/users/count Method
Count 'user' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Users model. |
GET Response Notes
The number of 'user' records matching filter.
Returns: integer
Related Models
- Advertisers referenced as
advertisers - Publishers referenced as
publishers - Agencies referenced as
agencies
agency/accounts/users/find Method
Find all 'user' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Users model. |
| fields | Array | List of fields from the Users model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Users items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Users followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'user' records that matched filter criteria.
Returns: array
Related Models
- Advertisers referenced as
advertisers - Publishers referenced as
publishers - Agencies referenced as
agencies
agency/advertisers Controller
Advertisers are the entities offering products or services to consumers over the (desktop or mobile) web or via a mobile app.
agency/advertisers/count Method
Gets the total number of entities matching the filter.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Advertisers model. |
GET Response Notes
The number of 'agency/advertisers' entities matching filter.
Returns: integer
Related Models
- Accounts referenced as
account - Users referenced as
primary_contact_user - Sites referenced as
sites - Campaigns referenced as
campaigns - Countries referenced as
country - Regions referenced as
region - Agencies referenced as
agency
agency/advertisers/find Method
Find all the 'agency/advertisers' objects by filter
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the Advertisers model. |
| fields | Array | List of fields from the Advertisers model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Advertisers items returned per request. |
| page | Integer | The page of results to return. |
| sort | Sort | Fields of Advertisers followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
'agency/advertisers' entities
Returns: array
Related Models
- Accounts referenced as
account - Users referenced as
primary_contact_user - Sites referenced as
sites - Campaigns referenced as
campaigns - Countries referenced as
country - Regions referenced as
region - Agencies referenced as
agency
agency/advertisers/sites Controller
The device-specific profile of a site; the advertiser's mobile app.
agency/advertisers/sites/count Method
Count 'site' records by filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard |
| filter | Filter | Filter by fields and boolean operators against fields of the Sites model. |
GET Response Notes
The number of 'site' records matching filter.
Returns: integer
agency/advertisers/sites/find Method
Find all 'site' records matching provided filter criteria.
| Name | Type | Description |
|---|---|---|
| api_key (required) | String | Your API Key; accessible on your User Details page of your Branch dashboard. |
| filter | Filter | Filter by fields and boolean operators against fields of the Sites model. |
| fields | Array | List of fields from the Sites model desired in results. Defaults to display all fields. |
| limit | Integer | Limit the number of Sites items returned per request. |
| page | Integer | Pagination offset of the limited result set. |
| sort | Sort | Fields of Sites followed by the direction (asc or desc). Results can be sorted with multiple fields and directions. |
GET Response Notes
List of found 'site' records that matched filter criteria.
Returns: array
Updated 7 months ago