Introduction

Orbee General API

Version: 2.0.0

Authentication

basic	Basic

/Accounts

GET

Summary: get a list of accounts. This list is filtered by the access the user has to different accounts

Description: get a list of accounts. This list is filtered by the access the user has to different accounts

HTTP Request

***GET*** /accounts

Responses

Code	Description
200	returns the user's list of accounts

POST

Summary: create a new account

Description: create a new account

HTTP Request

***POST*** /accounts

Parameters

Name	Located in	Description	Required	Type
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
name	formData	the name of the account	No	string
account_type	formData	the type of the account (vendor, dealership, etc.)	No	string

Responses

Code	Description
201	returns the newly created account

/Accounts/Tree

GET

Summary: get tree structure list of accounts and properties

Description: get tree structure list of accounts and properties

HTTP Request

***GET*** /accounts/tree

Responses

Code	Description
200	returns list of accounts each with their corresponding properties

/Accounts/{Account_Id}

GET

Summary: get an account

Description: get an account

HTTP Request

***GET*** /accounts/{account_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns the account's information

PATCH

Summary: update account info

Description: update account info

HTTP Request

***PATCH*** /accounts/{account_id}

Parameters

Name	Located in	Description	Required	Type
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
name	formData	the name of the account	No	string
account_type	formData	the type of the account (vendor, dealership, etc.)	No	string
account_id	path		Yes	integer

Responses

Code	Description
200	returns the new account info

DELETE

Summary: delete's an account

Description: delete's an account

HTTP Request

***DELETE*** /accounts/{account_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
202	returns success if it works
204	delete's an account

/Accounts/{Account_Id}/Sponsor

POST

Summary: sponsor another account

Description: sponsor another account

HTTP Request

***POST*** /accounts/{account_id}/sponsor

Parameters

Name	Located in	Description	Required	Type
id	formData	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer

Responses

Code	Description
200	returns success if it works
201	sponsor another account

/Accounts/{Account_Id}/Share

POST

Summary: share your account data with another account

Description: share your account data with another account

HTTP Request

***POST*** /accounts/{account_id}/share

Parameters

Name	Located in	Description	Required	Type
id	formData	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer

Responses

Code	Description
200	returns success if it works
201	share your account data with another account

DELETE

Summary: revoke access to shared account data

Description: revoke access to shared account data

HTTP Request

***DELETE*** /accounts/{account_id}/share

Parameters

Name	Located in	Description	Required	Type
id	query	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	query	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer

Responses

Code	Description
200	returns success if account access revoked
204	revoke access to shared account data

/Accounts/{Account_Id}/Settings

GET

Summary: get an account's settings

Description: get an account's settings

HTTP Request

***GET*** /accounts/{account_id}/settings

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update an account's settings

Description: update an account's settings

HTTP Request

***PATCH*** /accounts/{account_id}/settings

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	update an account's settings
201	returns the updated settings

/Accounts/{Account_Id}/Identifier_Pools

GET

Summary: gets a list of identity pools for a given account

Description: gets a list of identity pools for a given account

HTTP Request

***GET*** /accounts/{account_id}/identifier_pools

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of identity pools

POST

Summary: creates an identity pool under the given account

Description: creates an identity pool under the given account

HTTP Request

***POST*** /accounts/{account_id}/identifier_pools

Parameters

Name	Located in	Description	Required	Type
provider	formData	the name of the provider -- can be account name/alias for easiest use (setting to default this).	No	string
identifier_name	formData	the name of this identifier; for example: 'Orbee Rooftop Id' or 'Widget Id'	No	string
account_id	path		Yes	integer

Responses

Code	Description
201	returns the newly created identity pool

/Accounts/{Account_Id}/Identifier_Pools/Check_Availability

GET

Summary: check the availability of an identifier pool

Description: check the availability of an identifier pool

HTTP Request

***GET*** /accounts/{account_id}/identifier_pools/check_availability

Parameters

Name	Located in	Description	Required	Type
provider	query	the name of the provider -- can be account name/alias for easiest use (setting to default this).	No	string
identifier_name	query	the name of this identifier; for example: 'Orbee Rooftop Id' or 'Widget Id'	No	string
account_id	path	the account_id this identifier pool belongs to	Yes	integer

Responses

Code	Description
200	returns success if it's available

/Accounts/{Account_Id}/Users

GET

Summary: get a list of users in an account

Description: get a list of users in an account

HTTP Request

***GET*** /accounts/{account_id}/users

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of users in the account

/Accounts/{Account_Id}/Users/Invite

POST

Summary: invite a user to the given account

Description: invite a user to the given account

HTTP Request

***POST*** /accounts/{account_id}/users/invite

Parameters

Name	Located in	Description	Required	Type
email	formData	the email of the user	Yes	string
access	formData	the access for the invited user	No	string
role	formData	the role for the invited user	No	string
account_id	path		Yes	integer

Responses

Code	Description
201	invites a user to the account

/Accounts/{Account_Id}/Properties

GET

Summary: get a list of properties under the account

Description: get a list of properties under the account

HTTP Request

***GET*** /accounts/{account_id}/properties

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of properties in this account

POST

Summary: register a new property for this account

Description: register a new property for this account

HTTP Request

***POST*** /accounts/{account_id}/properties

Parameters

Name	Located in	Description	Required	Type
name	formData	the name of the property	No	string
source	formData	the source of the property (url, app id in app store, etc)	No	string
source_type	formData	the type of the source (web, android, ios, windows, desktop application, etc)	No	string
rooftop_id	formData	the id of the rooftop this property is a part of; used as a grouping mechanism	No	integer
vendor_id	formData	the id of the vendor that manages this property	No	integer
account_id	path		Yes	integer

Responses

Code	Description
201	returns the newly registered property

/Accounts/{Account_Id}/Properties/{Property_Id}

GET

Summary: get a property

Description: get a property

HTTP Request

***GET*** /accounts/{account_id}/properties/{property_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns the requested property

PATCH

Summary: update a property's info

Description: update a property's info

HTTP Request

***PATCH*** /accounts/{account_id}/properties/{property_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer
AccountsAccountIdProperties	body		Yes

Responses

Code	Description
200	update a property's info
201	returns the updated property

DELETE

Summary: delete a property

Description: delete a property

HTTP Request

***DELETE*** /accounts/{account_id}/properties/{property_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
202	returns success when deleted
204	delete a property

/Accounts/{Account_Id}/Properties/{Property_Id}/Share

POST

Summary: share a property with another account

Description: share a property with another account

HTTP Request

***POST*** /accounts/{account_id}/properties/{property_id}/share

Parameters

Name	Located in	Description	Required	Type
id	formData	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
201	share a property with another account
202	returns success if it works

DELETE

Summary: revoke access to a shared property

Description: revoke access to a shared property

HTTP Request

***DELETE*** /accounts/{account_id}/properties/{property_id}/share

Parameters

Name	Located in	Description	Required	Type
id	query	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	query	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns success if access is revoked
204	revoke access to a shared property

/Accounts/{Account_Id}/Properties/{Property_Id}/Site_Trackers

GET

Summary: get a list of site trackers on the property

Description: get a list of site trackers on the property

HTTP Request

***GET*** /accounts/{account_id}/properties/{property_id}/site_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns a list of site trackers

POST

Summary: create a site tracker

Description: create a site tracker

HTTP Request

***POST*** /accounts/{account_id}/properties/{property_id}/site_trackers

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
location	formData	the url to the hosted tracker code that runs on the site	No	string
google_analytics_ua	formData	optional setting for setting UA from GA for augmented data and tracking	No	string
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
201	create a site tracker
202	returns the created tracker

/Accounts/{Account_Id}/Properties/{Property_Id}/Campaigns

GET

Summary: get a list of campaigns running on this property

Description: get a list of campaigns running on this property

HTTP Request

***GET*** /accounts/{account_id}/properties/{property_id}/campaigns

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns a list of campaigns

/Accounts/{Account_Id}/Properties/{Property_Id}/Campaigns/Link

POST

Summary: link a campaign to this property

Description: link a campaign to this property

HTTP Request

***POST*** /accounts/{account_id}/properties/{property_id}/campaigns/link

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the campaign	No	integer
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
201	returns success if it worked

/Accounts/{Account_Id}/Properties/{Property_Id}/Tools

GET

Summary: get a list of tools running on this property

Description: get a list of tools running on this property

HTTP Request

***GET*** /accounts/{account_id}/properties/{property_id}/tools

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns a list of tools

/Accounts/{Account_Id}/Properties/{Property_Id}/Tools/Link

POST

Summary: link a tool to this property

Description: link a tool to this property

HTTP Request

***POST*** /accounts/{account_id}/properties/{property_id}/tools/link

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the tool	No	integer
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
201	returns success if it worked

/Accounts/{Account_Id}/Properties/{Property_Id}/Composites

GET

Summary: get a list of composites for this property

Description: get a list of composites for this property

HTTP Request

***GET*** /accounts/{account_id}/properties/{property_id}/composites

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns a list of composites

POST

Summary: create a composite for this property

Description: create a composite for this property

HTTP Request

***POST*** /accounts/{account_id}/properties/{property_id}/composites

Parameters

Name	Located in	Description	Required	Type
identifier_pool_id	formData	the identifier pool id for this composite	No	integer
identifier	formData	the identifier for this composite	No	integer
resource_id	formData	the resource (campaign, property, tool, shopper) id for this composite	No	integer
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
201	returns the new composite

/Accounts/{Account_Id}/Properties/{Property_Id}/Composites/Import

POST

Summary: import a bunch of id's from your system to ours [COMING SOON]

Description: import a bunch of id's from your system to ours [COMING SOON]

HTTP Request

***POST*** /accounts/{account_id}/properties/{property_id}/composites/import

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
201	import a bunch of id's from your system to ours [COMING SOON]

/Accounts/{Account_Id}/Properties/{Property_Id}/Metadata

GET

Summary: get a property's metadata

Description: get a property's metadata

HTTP Request

***GET*** /accounts/{account_id}/properties/{property_id}/metadata

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	returns a list of metadata

PATCH

Summary: update an property's metadata

Description: update an property's metadata

HTTP Request

***PATCH*** /accounts/{account_id}/properties/{property_id}/metadata

Parameters

Name	Located in	Description	Required	Type
metadata	formData	the metadata as key-value pairs	No	array
account_id	path		Yes	integer
property_id	path		Yes	integer

Responses

Code	Description
200	update an property's metadata
201	returns the updated metadata

/Accounts/{Account_Id}/Properties/Analytics/Query

GET

Summary: query property data

Description: query property data

HTTP Request

***GET*** /accounts/{account_id}/properties/analytics/query

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	the query data requested

/Accounts/{Account_Id}/Properties/Analytics/Series

GET

Summary: query series property data

Description: query series property data

HTTP Request

***GET*** /accounts/{account_id}/properties/analytics/series

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	the series data requested

/Accounts/{Account_Id}/Campaigns

GET

Summary: get a list of campaigns under the account

Description: get a list of campaigns under the account

HTTP Request

***GET*** /accounts/{account_id}/campaigns

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of campaigns in this account

POST

Summary: register a new campaign for this account

Description: register a new campaign for this account

HTTP Request

***POST*** /accounts/{account_id}/campaigns

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
AccountsAccountIdCampaigns	body		Yes

Responses

Code	Description
201	returns the newly registered campaign

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}

GET

Summary: get a campaign

Description: get a campaign

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns the requested campaign

PATCH

Summary: update a campaign's information

Description: update a campaign's information

HTTP Request

***PATCH*** /accounts/{account_id}/campaigns/{campaign_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer
AccountsAccountIdCampaigns	body		Yes

Responses

Code	Description
200	update a campaign's information
201	returns the updated campaign

DELETE

Summary: delete a campaign

Description: delete a campaign

HTTP Request

***DELETE*** /accounts/{account_id}/campaigns/{campaign_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete a campaign

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Share

POST

Summary: share a campaign with another account

Description: share a campaign with another account

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/share

Parameters

Name	Located in	Description	Required	Type
id	formData	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
201	share a campaign with another account
202	returns success if it works

DELETE

Summary: revoke access to a shared campaign

Description: revoke access to a shared campaign

HTTP Request

***DELETE*** /accounts/{account_id}/campaigns/{campaign_id}/share

Parameters

Name	Located in	Description	Required	Type
id	query	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	query	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns success if access is revoked
204	revoke access to a shared campaign

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Properties

GET

Summary: lists properties this campaign is running on

Description: lists properties this campaign is running on

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}/properties

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns a list of properties

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Properties/Link

POST

Summary: link a property to this campaign

Description: link a property to this campaign

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/properties/link

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the registered property	No	integer
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
201	link a property to this campaign
202	returns success if it works

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Click_Trackers

GET

Summary: get a list of click trackers

Description: get a list of click trackers

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}/click_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

POST

Summary: create a click tracker

Description: create a click tracker

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/click_trackers

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
network_type	formData	the network type of the tracker (network or client)	No	string
account_id	path	the account id this tracker is tied to	Yes	integer
campaign_id	path	the campaign id this tracker is tied to	Yes	integer

Responses

Code	Description
201	create a click tracker
202	returns the created tracker

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Viewthrough_Trackers

GET

Summary: get a list of view-through trackers

Description: get a list of view-through trackers

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}/viewthrough_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

POST

Summary: create a view-through tracker

Description: create a view-through tracker

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/viewthrough_trackers

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
account_id	path	the account id this tracker is tied to	Yes	integer
campaign_id	path	the campaign id this tracker is tied to	Yes	integer

Responses

Code	Description
201	create a view-through tracker
202	returns the created tracker

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Phone_Trackers

GET

Summary: get a list of phone trackers

Description: get a list of phone trackers

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}/phone_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

POST

Summary: create a phone tracker

Description: create a phone tracker

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/phone_trackers

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
old_phone_number	formData	the phone number being replaced	No	string
new_phone_number	formData	the new phone number to display	No	string
account_id	path	the account id this tracker is tied to	Yes	integer
campaign_id	path	the campaign id this tracker is tied to	Yes	integer

Responses

Code	Description
201	create a phone tracker
202	returns the created tracker

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Composites

GET

Summary: get a list of composites for this campaign

Description: get a list of composites for this campaign

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}/composites

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns a list of composites

POST

Summary: create a composite for this campaign

Description: create a composite for this campaign

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/composites

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the composite record	No	integer
account_id	path	the account id for this composite	Yes	integer
identifier_pool_id	formData	the identifier pool id for this composite	No	integer
identifier	formData	the identifier for this composite	No	integer
resource_id	formData	the resource (campaign, property, tool, shopper) id for this composite	No	integer
campaign_id	path		Yes	integer

Responses

Code	Description
201	returns the new composite

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Composites/Import

POST

Summary: import a bunch of id's from your system to ours [COMING SOON]

Description: import a bunch of id's from your system to ours [COMING SOON]

HTTP Request

***POST*** /accounts/{account_id}/campaigns/{campaign_id}/composites/import

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
201	import a bunch of id's from your system to ours [COMING SOON]

/Accounts/{Account_Id}/Campaigns/{Campaign_Id}/Metadata

GET

Summary: get a campaign's metadata

Description: get a campaign's metadata

HTTP Request

***GET*** /accounts/{account_id}/campaigns/{campaign_id}/metadata

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	returns a list of metadata

PATCH

Summary: update an campaign's metadata

Description: update an campaign's metadata

HTTP Request

***PATCH*** /accounts/{account_id}/campaigns/{campaign_id}/metadata

Parameters

Name	Located in	Description	Required	Type
metadata	formData	the metadata as key-value pairs	No	array
account_id	path		Yes	integer
campaign_id	path		Yes	integer

Responses

Code	Description
200	update an campaign's metadata
201	returns the updated metadata

/Accounts/{Account_Id}/Campaigns/Analytics/Query

GET

Summary: query campaign data

Description: query campaign data

HTTP Request

***GET*** /accounts/{account_id}/campaigns/analytics/query

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	the query data requested

/Accounts/{Account_Id}/Campaigns/Analytics/Series

GET

Summary: query series campaign data

Description: query series campaign data

HTTP Request

***GET*** /accounts/{account_id}/campaigns/analytics/series

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	the series data requested

/Accounts/{Account_Id}/Tools

GET

Summary: get a list of tools under the account

Description: get a list of tools under the account

HTTP Request

***GET*** /accounts/{account_id}/tools

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of registered tools in this account

POST

Summary: register a new tool for this account

Description: register a new tool for this account

HTTP Request

***POST*** /accounts/{account_id}/tools

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
AccountsAccountIdTools	body		Yes

Responses

Code	Description
201	returns the newly registered tool

/Accounts/{Account_Id}/Tools/{Tool_Id}

GET

Summary: get a tool

Description: get a tool

HTTP Request

***GET*** /accounts/{account_id}/tools/{tool_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	returns the requested tool

PATCH

Summary: update a tool's info

Description: update a tool's info

HTTP Request

***PATCH*** /accounts/{account_id}/tools/{tool_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer
AccountsAccountIdTools	body		Yes

Responses

Code	Description
200	update a tool's info
201	returns the updated tool

DELETE

Summary: delete a registered tool resource

Description: delete a registered tool resource

HTTP Request

***DELETE*** /accounts/{account_id}/tools/{tool_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete a registered tool resource

/Accounts/{Account_Id}/Tools/{Tool_Id}/Share

POST

Summary: share this tool with another account

Description: share this tool with another account

HTTP Request

***POST*** /accounts/{account_id}/tools/{tool_id}/share

Parameters

Name	Located in	Description	Required	Type
id	formData	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	formData	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
201	share this tool with another account
202	returns success if it worked

DELETE

Summary: revoke access to a shared tool

Description: revoke access to a shared tool

HTTP Request

***DELETE*** /accounts/{account_id}/tools/{tool_id}/share

Parameters

Name	Located in	Description	Required	Type
id	query	the system id of the account (interchangeable with the system alias for the account)	No	integer
alias	query	the system alias for the account (interchangeable with the system id for the account)	No	string
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	returns success if access is revoked
204	revoke access to a shared tool

/Accounts/{Account_Id}/Tools/{Tool_Id}/Properties

GET

Summary: lists properties this tool is running on

Description: lists properties this tool is running on

HTTP Request

***GET*** /accounts/{account_id}/tools/{tool_id}/properties

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	returns a list of properties

/Accounts/{Account_Id}/Tools/{Tool_Id}/Properties/Link

POST

Summary: link a property to this tool

Description: link a property to this tool

HTTP Request

***POST*** /accounts/{account_id}/tools/{tool_id}/properties/link

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the registered property	No	integer
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
201	link a property to this tool
202	returns success if it works

/Accounts/{Account_Id}/Tools/{Tool_Id}/Truecount_Trackers

GET

Summary: get a list of true-count trackers

Description: get a list of true-count trackers

HTTP Request

***GET*** /accounts/{account_id}/tools/{tool_id}/truecount_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

POST

Summary: create a true-count tracker

Description: create a true-count tracker

HTTP Request

***POST*** /accounts/{account_id}/tools/{tool_id}/truecount_trackers

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
account_id	path	the account id this tracker is tied to	Yes	integer
tool_id	path	the tool id this tracker is tied to	Yes	integer

Responses

Code	Description
201	create a true-count tracker
202	returns the created tracker

/Accounts/{Account_Id}/Tools/{Tool_Id}/Composites

GET

Summary: get a list of composites for this tool

Description: get a list of composites for this tool

HTTP Request

***GET*** /accounts/{account_id}/tools/{tool_id}/composites

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	returns a list of composites

POST

Summary: create a composite for this tool

Description: create a composite for this tool

HTTP Request

***POST*** /accounts/{account_id}/tools/{tool_id}/composites

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the composite record	No	integer
account_id	path	the account id for this composite	Yes	integer
identifier_pool_id	formData	the identifier pool id for this composite	No	integer
identifier	formData	the identifier for this composite	No	integer
resource_id	formData	the resource (campaign, property, tool, shopper) id for this composite	No	integer
tool_id	path		Yes	integer

Responses

Code	Description
201	returns the new composite

/Accounts/{Account_Id}/Tools/{Tool_Id}/Composites/Import

POST

Summary: import a bunch of id's from your system to ours [COMING SOON]

Description: import a bunch of id's from your system to ours [COMING SOON]

HTTP Request

***POST*** /accounts/{account_id}/tools/{tool_id}/composites/import

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
201	import a bunch of id's from your system to ours [COMING SOON]

/Accounts/{Account_Id}/Tools/{Tool_Id}/Metadata

GET

Summary: get a tool's metadata

Description: get a tool's metadata

HTTP Request

***GET*** /accounts/{account_id}/tools/{tool_id}/metadata

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	returns a list of metadata

PATCH

Summary: update an tool's metadata

Description: update an tool's metadata

HTTP Request

***PATCH*** /accounts/{account_id}/tools/{tool_id}/metadata

Parameters

Name	Located in	Description	Required	Type
metadata	formData	the metadata as key-value pairs	No	array
account_id	path		Yes	integer
tool_id	path		Yes	integer

Responses

Code	Description
200	update an tool's metadata
201	returns the updated metadata

/Accounts/{Account_Id}/Tools/Analytics/Query

GET

Summary: query tool data

Description: query tool data

HTTP Request

***GET*** /accounts/{account_id}/tools/analytics/query

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	the query data requested

/Accounts/{Account_Id}/Tools/Analytics/Series

GET

Summary: query series tool data

Description: query series tool data

HTTP Request

***GET*** /accounts/{account_id}/tools/analytics/series

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	the series data requested

/Accounts/{Account_Id}/Reports

GET

Summary: get a list of reports under the account

Description: get a list of reports under the account

HTTP Request

***GET*** /accounts/{account_id}/reports

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of reports shared with this account

/Accounts/{Account_Id}/Reports/{Report_Id}

GET

Summary: runs a selected report and returns generated data

Description: runs a selected report and returns generated data

HTTP Request

***GET*** /accounts/{account_id}/reports/{report_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
report_id	path		Yes	integer

Responses

Code	Description
200	returns a table of report data

/Accounts/{Account_Id}/Actions

GET

Summary: get a list of actions under the account

Description: get a list of actions under the account

HTTP Request

***GET*** /accounts/{account_id}/actions

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of actions in this account

/Accounts/{Account_Id}/Actions/{Action_Id}

PATCH

Summary: edit a status for an action

Description: edit a status for an action

HTTP Request

***PATCH*** /accounts/{account_id}/actions/{action_id}

Parameters

Name	Located in	Description	Required	Type
completed	formData	completed status of action	No	boolean
verified	formData	verified complete status of the action	No	boolean
account_id	path		Yes	integer
action_id	path		Yes	integer

Responses

Code	Description
200	action updated sucessfully

/Accounts/{Account_Id}/Click_Trackers

GET

Summary: get a list of click trackers

Description: get a list of click trackers

HTTP Request

***GET*** /accounts/{account_id}/click_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

/Accounts/{Account_Id}/Click_Trackers/{Tracker_Id}

GET

Summary: get a tracker

Description: get a tracker

HTTP Request

***GET*** /accounts/{account_id}/click_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns the tracker

PATCH

Summary: update a tracker's info

Description: update a tracker's info

HTTP Request

***PATCH*** /accounts/{account_id}/click_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
network_type	formData	the network type of the tracker (network or client)	No	string
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update a tracker's info
201	returns the updated tracker

DELETE

Summary: delete the click tracker

Description: delete the click tracker

HTTP Request

***DELETE*** /accounts/{account_id}/click_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete the click tracker

/Accounts/{Account_Id}/Click_Trackers/{Tracker_Id}/Settings

GET

Summary: get the tracker settings

Description: get the tracker settings

HTTP Request

***GET*** /accounts/{account_id}/click_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update the tracker's settings

Description: update the tracker's settings

HTTP Request

***PATCH*** /accounts/{account_id}/click_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update the tracker's settings
201	returns the updated settings

/Accounts/{Account_Id}/Phone_Trackers

GET

Summary: get a list of phone trackers

Description: get a list of phone trackers

HTTP Request

***GET*** /accounts/{account_id}/phone_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

/Accounts/{Account_Id}/Phone_Trackers/{Tracker_Id}

GET

Summary: get a tracker

Description: get a tracker

HTTP Request

***GET*** /accounts/{account_id}/phone_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns the tracker

PATCH

Summary: update a tracker's info

Description: update a tracker's info

HTTP Request

***PATCH*** /accounts/{account_id}/phone_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
old_phone_number	formData	the phone number being replaced	No	string
new_phone_number	formData	the new phone number to display	No	string
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update a tracker's info
201	returns the updated tracker

DELETE

Summary: delete the phone tracker

Description: delete the phone tracker

HTTP Request

***DELETE*** /accounts/{account_id}/phone_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete the phone tracker

/Accounts/{Account_Id}/Phone_Trackers/{Tracker_Id}/Settings

GET

Summary: get the tracker settings

Description: get the tracker settings

HTTP Request

***GET*** /accounts/{account_id}/phone_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update the tracker's settings

Description: update the tracker's settings

HTTP Request

***PATCH*** /accounts/{account_id}/phone_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update the tracker's settings
201	returns the updated settings

/Accounts/{Account_Id}/Site_Trackers

GET

Summary: get a list of site trackers

Description: get a list of site trackers

HTTP Request

***GET*** /accounts/{account_id}/site_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

/Accounts/{Account_Id}/Site_Trackers/{Tracker_Id}

GET

Summary: get a tracker

Description: get a tracker

HTTP Request

***GET*** /accounts/{account_id}/site_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns the tracker

PATCH

Summary: update a tracker's info

Description: update a tracker's info

HTTP Request

***PATCH*** /accounts/{account_id}/site_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
location	formData	the url to the hosted tracker code that runs on the site	No	string
google_analytics_ua	formData	optional setting for setting UA from GA for augmented data and tracking	No	string
property_id	formData	the id of the property this site tracker is installed on	No	integer
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update a tracker's info
201	returns the updated tracker

DELETE

Summary: delete the site tracker

Description: delete the site tracker

HTTP Request

***DELETE*** /accounts/{account_id}/site_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete the site tracker

/Accounts/{Account_Id}/Site_Trackers/{Tracker_Id}/Settings

GET

Summary: get the tracker settings

Description: get the tracker settings

HTTP Request

***GET*** /accounts/{account_id}/site_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update the tracker's settings

Description: update the tracker's settings

HTTP Request

***PATCH*** /accounts/{account_id}/site_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update the tracker's settings
201	returns the updated settings

/Accounts/{Account_Id}/Site_Trackers/{Tracker_Id}/Domain

GET

Summary: check a tracker's domain against a provided value

Description: check a tracker's domain against a provided value

HTTP Request

***GET*** /accounts/{account_id}/site_trackers/{tracker_id}/domain

Parameters

Name	Located in	Description	Required	Type
domain	query	domain to compare	Yes	string
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	Result of requested check

/Accounts/{Account_Id}/Site_Trackers/{Tracker_Id}/Locations

GET

Summary: get all of the locations for a tracker's market.

Description: get all of the locations for a tracker's market.

HTTP Request

***GET*** /accounts/{account_id}/site_trackers/{tracker_id}/locations

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	get tracker locations.

POST

Summary: create new locations as part of a tracker's market

Description: create new locations as part of a tracker's market

HTTP Request

***POST*** /accounts/{account_id}/site_trackers/{tracker_id}/locations

Parameters

Name	Located in	Description	Required	Type
locations	formData	an array of market locations.	Yes	array
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
201	tracker market locations created.
400	error indicating improperly formatted locations

/Accounts/{Account_Id}/Site_Trackers/{Tracker_Id}/Locations/{Location_Id}

PATCH

Summary: update a location in a tracker's market

Description: update a location in a tracker's market

HTTP Request

***PATCH*** /accounts/{account_id}/site_trackers/{tracker_id}/locations/{location_id}

Parameters

Name	Located in	Description	Required	Type
id	formData	id of the location	No	integer
address_line_1	formData	market location address line 1	No	string
address_line_2	formData	market location address line 2	No	string
address_city	formData	market location city	No	string
address_state	formData	market location state	No	string
address_zipcode	formData	market location zip code	No	string
address_country	formData	market location country	No	string
radius	formData	market location radius	No	integer
account_id	path		Yes	integer
tracker_id	path		Yes	integer
location_id	path		Yes	integer

Responses

Code	Description
200	tracker market location that was updated
400	error indicating improperly formatted locations
403	error indicating attempt to edit default address

DELETE

Summary: delete a location from a tracker's market

Description: delete a location from a tracker's market

HTTP Request

***DELETE*** /accounts/{account_id}/site_trackers/{tracker_id}/locations/{location_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer
location_id	path		Yes	integer

Responses

Code	Description
204	tracker location successfully deleted
403	error indicating attempt to delete default address

/Accounts/{Account_Id}/Truecount_Trackers

GET

Summary: get a list of true-count trackers

Description: get a list of true-count trackers

HTTP Request

***GET*** /accounts/{account_id}/truecount_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

/Accounts/{Account_Id}/Truecount_Trackers/{Tracker_Id}

GET

Summary: get a tracker

Description: get a tracker

HTTP Request

***GET*** /accounts/{account_id}/truecount_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns the tracker

PATCH

Summary: update a tracker's info

Description: update a tracker's info

HTTP Request

***PATCH*** /accounts/{account_id}/truecount_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
tool_id	formData	the tool id this tracker is tied to	No	integer
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update a tracker's info
201	returns the updated tracker

DELETE

Summary: delete the true-count tracker

Description: delete the true-count tracker

HTTP Request

***DELETE*** /accounts/{account_id}/truecount_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete the true-count tracker

/Accounts/{Account_Id}/Truecount_Trackers/{Tracker_Id}/Settings

GET

Summary: get the tracker settings

Description: get the tracker settings

HTTP Request

***GET*** /accounts/{account_id}/truecount_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update the tracker's settings

Description: update the tracker's settings

HTTP Request

***PATCH*** /accounts/{account_id}/truecount_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update the tracker's settings
201	returns the updated settings

/Accounts/{Account_Id}/Viewthrough_Trackers

GET

Summary: get a list of view-through trackers

Description: get a list of view-through trackers

HTTP Request

***GET*** /accounts/{account_id}/viewthrough_trackers

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer

Responses

Code	Description
200	returns a list of trackers

/Accounts/{Account_Id}/Viewthrough_Trackers/{Tracker_Id}

GET

Summary: get a tracker

Description: get a tracker

HTTP Request

***GET*** /accounts/{account_id}/viewthrough_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns the tracker

PATCH

Summary: update a tracker's info

Description: update a tracker's info

HTTP Request

***PATCH*** /accounts/{account_id}/viewthrough_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
source	formData	the source of the tracker (s3 file w/ javascript, tied to version)	No	string
version	formData	the version of the tracker	No	string
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update a tracker's info
201	returns the updated tracker

DELETE

Summary: delete the view-through tracker

Description: delete the view-through tracker

HTTP Request

***DELETE*** /accounts/{account_id}/viewthrough_trackers/{tracker_id}

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	delete the view-through tracker

/Accounts/{Account_Id}/Viewthrough_Trackers/{Tracker_Id}/Settings

GET

Summary: get the tracker settings

Description: get the tracker settings

HTTP Request

***GET*** /accounts/{account_id}/viewthrough_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update the tracker's settings

Description: update the tracker's settings

HTTP Request

***PATCH*** /accounts/{account_id}/viewthrough_trackers/{tracker_id}/settings

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array
account_id	path		Yes	integer
tracker_id	path		Yes	integer

Responses

Code	Description
200	update the tracker's settings
201	returns the updated settings

/Accounts/{Account_Id}/Analytics/Query

GET

Summary: General analytics query call

Description: General analytics query call

HTTP Request

***GET*** /accounts/{account_id}/analytics/query

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
dimensions	formData	a list of dimensions to get data broken down by	No	array
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	requested data
400	error indicating request is in an incorrect format

/Accounts/{Account_Id}/Analytics/Series

GET

Summary: General analytics series call

Description: General analytics series call

HTTP Request

***GET*** /accounts/{account_id}/analytics/series

Parameters

Name	Located in	Description	Required	Type
property_id	query	return data for specified property	No	integer
start_date	query	the start timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
end_date	query	the end timestamp (form 'YYYY/MM/DD HH:mm:ss')	No	string
metrics	formData	a list of metrics to get, broken down by the given dimensions	No	array
sort	query	string of field to sort by and direction to sort, separated by a pipe	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer
filters	formData	a list of filters to apply to the data query	No	array
account_id	path		Yes	integer

Responses

Code	Description
200	requested data
400	error indicating request is in an incorrect format

/Accounts/{Account_Id}/Analytics/Clicks

GET

Summary: get source or medium data for a tracker

Description: get source or medium data for a tracker

HTTP Request

***GET*** /accounts/{account_id}/analytics/clicks

Parameters

Name	Located in	Description	Required	Type
start_date	query	return data starting on specified date	Yes	dateTime
end_date	query	return data ending on specified date	Yes	dateTime
tracker_id	query	tracker id	Yes	integer
source	query	source from tracker data	No	string
account_id	path		Yes	integer

Responses

Code	Description
200	returns list of values for either source or medium
400	returns an error indicating inability to process request

/Accounts/{Account_Id}/Analytics/Clicks/Data

GET

Summary: get click query data for a tracker

Description: get click query data for a tracker

HTTP Request

***GET*** /accounts/{account_id}/analytics/clicks/data

Parameters

Name	Located in	Description	Required	Type
start_date	query	return data starting on specified date	Yes	dateTime
end_date	query	return data ending on specified date	Yes	dateTime
tracker_id	query	tracker id	Yes	integer
source	query	source from tracker data	No	string
medium	query	medium from tracker data	No	string
url_filters	query	filter to be applied to page url	No	AnalyticClickFilter
filter_op	query	how to combine filters: (and,or)	No	string
account_id	path		Yes	integer

Responses

Code	Description
200	returns list of query selectors for html elements
400	returns an error indicating inability to process request

/Accounts/{Account_Id}/Analytics/Tc

GET

Summary: get true count values for a specified tracker/composite or all trackers/composites

Description: get true count values for a specified tracker/composite or all trackers/composites

HTTP Request

***GET*** /accounts/{account_id}/analytics/tc

Parameters

Name	Located in	Description	Required	Type
start_date	query	return data starting on specified date	Yes	dateTime
end_date	query	return data ending on specified date	Yes	dateTime
tid	query	tracker id to pull data	No	integer
aid	query	account id to pull data	No	integer
pid	query	pool id to pull data	No	integer
id	query	corresponding identifier for id pool	No	text
account_id	path		Yes	integer

Responses

Code	Description
200	returns the requested data values either for one or all trackers or composites.
400	returns an error indicating inability to process request

/Accounts/{Account_Id}/Analytics/Tq

GET

Summary: get traffic quality for a specified tracker/composite or all trackers/composites

Description: get traffic quality for a specified tracker/composite or all trackers/composites

HTTP Request

***GET*** /accounts/{account_id}/analytics/tq

Parameters

Name	Located in	Description	Required	Type
start_date	query	return data starting on specified date	Yes	dateTime
end_date	query	return data ending on specified date	Yes	dateTime
tid	query	tracker id to pull data	No	integer
aid	query	account id to pull data	No	integer
pid	query	pool id to pull data	No	integer
id	query	corresponding identifier for id pool	No	text
account_id	path		Yes	integer

Responses

Code	Description
200	returns the requested data values either for one or all trackers or composites.
400	returns an error indicating inability to process request

/Notifications

GET

Summary: get a list of notifications

Description: get a list of notifications

HTTP Request

***GET*** /notifications

Responses

Code	Description
200	returns a list of notifications

POST

Summary: create a notification

Description: create a notification

HTTP Request

***POST*** /notifications

Parameters

Name	Located in	Description	Required	Type
medium	formData	the medium to send the notification in by default	No	string
override_settings	formData	whether or not to override the recipient's settings	No	boolean
group	formData	whether or not this notification can be grouped up with others	No	boolean
is_cancelled	formData	whether this notification has been cancelled or not	No	boolean
is_sent	formData	whether this notification has been sent or not	No	boolean
priority	formData	the priority of the message (low, medium, high, auto)	No	string
when	formData	when this notification is scheduled to send	No	string
message_url	formData	the url to the message or message template	No	string
message_type	formData	message type (custom or template)	No	string
message_params	formData	the params for the message if it's a template	No	object
subject	formData	the subject of the message	No	string
tags	formData	the tags associated with the notification	No	object
filterable_tags	formData	the tags associated with the notification that can be filtered with a user's blacklist	No	object
recipients	formData	the recipients of the notification	No	array

Responses

Code	Description
201	returns the created notification

/Notifications/{Notification_Id}

GET

Summary: get a notification

Description: get a notification

HTTP Request

***GET*** /notifications/{notification_id}

Parameters

Name	Located in	Description	Required	Type
notification_id	path		Yes	integer

Responses

Code	Description
200	returns the notification

DELETE

Summary: cancel a notification

Description: cancel a notification

HTTP Request

***DELETE*** /notifications/{notification_id}

Parameters

Name	Located in	Description	Required	Type
notification_id	path		Yes	integer

Responses

Code	Description
202	returns success if it worked
204	cancel a notification

/Rooftops/Suggestions

GET

Summary: get a list of suggested rooftop names

Description: get a list of suggested rooftop names

HTTP Request

***GET*** /rooftops/suggestions

Responses

Code	Description
200	returns a list of rooftop names

/Site_Tracker_Account/{Site_Tracker_Id}

GET

Summary: get an account associated with a site tracker

Description: get an account associated with a site tracker

HTTP Request

***GET*** /site_tracker_account/{site_tracker_id}

Parameters

Name	Located in	Description	Required	Type
site_tracker_id	path		Yes	integer

Responses

Code	Description
200	returns an account id

/Users

GET

Summary: get a list of users in the system

Description: get a list of users in the system

HTTP Request

***GET*** /users

Responses

Code	Description
200	returns a list of users

POST

Summary: create a new user

Description: create a new user

HTTP Request

***POST*** /users

Parameters

Name	Located in	Description	Required	Type
name	formData	the name of the user	No	string
email	formData	the email of the user	No	string
phone	formData	the phone number of the user	No	string

Responses

Code	Description
201	returns the newly created user

/User

GET

Summary: get your user info

Description: get your user info

HTTP Request

***GET*** /user

Responses

Code	Description
200	returns your user info

PATCH

Summary: update you user info

Description: update you user info

HTTP Request

***PATCH*** /user

Parameters

Name	Located in	Description	Required	Type
id	formData	the id of the user	No	integer
name	formData	the name of the user	No	string
email	formData	the email of the user	No	string
phone	formData	the phone number of the user	No	string

Responses

Code	Description
200	update you user info
201	returns the updated user

DELETE

Summary: deletes your user from Orbee's system

Description: deletes your user from Orbee's system

HTTP Request

***DELETE*** /user

Responses

Code	Description
202	returns success if it worked
204	deletes your user from Orbee's system

/User/Accounts

GET

Summary: get a list of accounts for this user

Description: get a list of accounts for this user

HTTP Request

***GET*** /user/accounts

Responses

Code	Description
200	returns a list of accounts

/User/Token

GET

Summary: generate a user authentication token

Description: generate a user authentication token

HTTP Request

***GET*** /user/token

Parameters

Name	Located in	Description	Required	Type
api_key	query	api access key	No	string

Responses

Code	Description
200	created token
401	returns error indicating session creation failed
403	returns error indicating session creation failed

/User/Token/Impersonate

GET

Summary: generate a user impersonation token

Description: generate a user impersonation token

HTTP Request

***GET*** /user/token/impersonate

Parameters

Name	Located in	Description	Required	Type
id	query	the id of the user	No	integer

Responses

Code	Description
200	created token
403	returns error indicating session creation failed
404	returns error indicating session creation failed

/User/Pass_Token

GET

Summary: check validity of pass token

Description: check validity of pass token

HTTP Request

***GET*** /user/pass_token

Responses

Code	Description
200	valid token provided
404	token not found

/User/Password

PATCH

Summary: set new password

Description: set new password

HTTP Request

***PATCH*** /user/password

Parameters

Name	Located in	Description	Required	Type
current_password	formData	current password	Yes	string
password	formData	new password	Yes	string
password_confirmation	formData	confirmation of new password	Yes	string

Responses

Code	Description
200	password successfully changed
400	error indicating invalid password

/User/Forgot_Password

GET

Summary: issue reset password token

Description: issue reset password token

HTTP Request

***GET*** /user/forgot_password

Parameters

Name	Located in	Description	Required	Type
email	query	the email of the user	No	string

Responses

Code	Description
200	reset password link issued

/User/Settings/General

GET

Summary: get an user's settings

Description: get an user's settings

HTTP Request

***GET*** /user/settings/general

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update an user's settings

Description: update an user's settings

HTTP Request

***PATCH*** /user/settings/general

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array

Responses

Code	Description
200	update an user's settings
201	returns the updated settings

/User/Settings/Notifications

GET

Summary: get an user's notification settings

Description: get an user's notification settings

HTTP Request

***GET*** /user/settings/notifications

Responses

Code	Description
200	returns a list of settings

PATCH

Summary: update an user's notification settings

Description: update an user's notification settings

HTTP Request

***PATCH*** /user/settings/notifications

Parameters

Name	Located in	Description	Required	Type
settings	formData	the settings as key-value pairs	No	array

Responses

Code	Description
200	update an user's notification settings
201	returns the updated settings

/Vendors/Suggestions

GET

Summary: get a list of suggested vendor names

Description: get a list of suggested vendor names

HTTP Request

***GET*** /vendors/suggestions

Responses

Code	Description
200	returns a list of vendor names

/Proto/Click_Trackers/Raw

GET

Summary: get click tracker data at a hit level

Description: get click tracker data at a hit level

HTTP Request

***GET*** /proto/click_trackers/raw

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime
action_type	query	action type to filter for in this request, either 'click' or 'view'	No	string
campaigns	formData	array of campaign values to select values	No	array
sort	query	sort field and direction, pipe delimited	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer

Responses

Code	Description
200	returns click tracker data at hit level
400	error indicating inability to process request

/Proto/Click_Trackers/Raw/Download

GET

Summary: request raw click tracker data report be generated

Description: request raw click tracker data report be generated

HTTP Request

***GET*** /proto/click_trackers/raw/download

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime
action_type	query	action type to filter for in this request, either 'click' or 'view'	No	string
campaigns	formData	array of campaign values to select values	No	array
sort	query	sort field and direction, pipe delimited	No	string

Responses

Code	Description
200	request raw click tracker data report be generated
202	request has been accepted, processing in progress
400	error indicating inability to process request

/Proto/Click_Trackers/Ip

GET

Summary: get click tracker data at ip level

Description: get click tracker data at ip level

HTTP Request

***GET*** /proto/click_trackers/ip

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime
action_type	query	action type to filter for in this request, either 'click' or 'view'	No	string
campaigns	formData	array of campaign values to select values	No	array
sort	query	sort field and direction, pipe delimited	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer

Responses

Code	Description
200	returns click tracker data at ip level
400	error indicating inability to process request

/Proto/Click_Trackers/Ip/Download

GET

Summary: request ip click tracker data report be generated

Description: request ip click tracker data report be generated

HTTP Request

***GET*** /proto/click_trackers/ip/download

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime
action_type	query	action type to filter for in this request, either 'click' or 'view'	No	string
campaigns	formData	array of campaign values to select values	No	array
sort	query	sort field and direction, pipe delimited	No	string

Responses

Code	Description
200	request ip click tracker data report be generated
202	request has been accepted, processing in progress
400	error indicating inability to process request

/Proto/Click_Trackers/Aggregate

GET

Summary: get click tracker data at aggregate level

Description: get click tracker data at aggregate level

HTTP Request

***GET*** /proto/click_trackers/aggregate

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime
action_type	query	action type to filter for in this request, either 'click' or 'view'	No	string
campaigns	formData	array of campaign values to select values	No	array
sort	query	sort field and direction, pipe delimited	No	string
page	query	page number	No	integer
per_page	query	page size	No	integer

Responses

Code	Description
200	returns click tracker data at aggregate level
400	error indicating inability to process request

/Proto/Click_Trackers/Aggregate/Download

GET

Summary: request aggregate click tracker data report be generated

Description: request aggregate click tracker data report be generated

HTTP Request

***GET*** /proto/click_trackers/aggregate/download

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime
action_type	query	action type to filter for in this request, either 'click' or 'view'	No	string
campaigns	formData	array of campaign values to select values	No	array
sort	query	sort field and direction, pipe delimited	No	string

Responses

Code	Description
200	request aggregate click tracker data report be generated
202	request has been accepted, processing in progress
400	error indicating inability to process request

/Proto/Click_Trackers/Reports

GET

Summary: get list of ready reports

Description: get list of ready reports

HTTP Request

***GET*** /proto/click_trackers/reports

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer

Responses

Code	Description
200	returns list of ready reports
400	error indicating inability to process request

/Proto/Click_Trackers/Reports/{Report_Id}

DELETE

Summary: delete a report

Description: delete a report

HTTP Request

***DELETE*** /proto/click_trackers/reports/{report_id}

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
report_id	path		Yes	integer

Responses

Code	Description
200	returns status indicating report deleted
204	delete a report
400	returns error indicating inability to delete report

PUT

Summary: reprocess a report

Description: reprocess a report

HTTP Request

***PUT*** /proto/click_trackers/reports/{report_id}

Parameters

Name	Located in	Description	Required	Type
account_id	formData	account id to pull click tracker data for	Yes	integer
report_id	path		Yes	integer

Responses

Code	Description
200	reprocess a report
202	request has been accepted, processing in progress

/Proto/Click_Trackers/Clicks

GET

Summary: get number of clicks used

Description: get number of clicks used

HTTP Request

***GET*** /proto/click_trackers/clicks

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime

Responses

Code	Description
200	returns number of clicks used
400	return error indicating inability to process request

/Proto/Click_Trackers/Campaigns

GET

Summary: get campaign ids

Description: get campaign ids

HTTP Request

***GET*** /proto/click_trackers/campaigns

Parameters

Name	Located in	Description	Required	Type
account_id	query	account id to pull click tracker data for	Yes	integer
start_date	query	start date to pull data	Yes	dateTime
end_date	query	end date to pull data	Yes	dateTime

Responses

Code	Description
200	returns list of campaign ids
400	return error indicating inability to process request

/Diagnostics/Readable_Cookies

GET

Summary: get all readable cookies

Description: get all readable cookies

HTTP Request

***GET*** /diagnostics/readable_cookies

Responses

Code	Description
200	returns list of readable cookies

/Diagnostics/Tpc_Set

GET

Summary: set a third party cookie

Description: set a third party cookie

HTTP Request

***GET*** /diagnostics/tpc_set

Responses

Code	Description
200	returns list of third party cookies

/Diagnostics/Tpc_Check

GET

Summary: get list of set third party cookies

Description: get list of set third party cookies

HTTP Request

***GET*** /diagnostics/tpc_check

Responses

Code	Description
200	returns list of tpcs

Errors

The Orbee API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Unable to process request.
401	Unauthorized -- Invalid Credentials.
403	Forbidden -- Action Not Allowed.
404	Not Found -- Resource Not Found.
405	Method Not Allowed -- Invalid Method.
406	Not Acceptable -- Invalid Data Format.
410	Gone -- Resource Removed.
429	Too Many Requests -- Exceeded Limit on Requests
500	Internal Server Error -- Try Again Later.
503	Service Unavailable -- Try Again Later.