Traffic source management.
Retrieve a traffic source by its id
Retrieve a traffic source by its id
query Parameters
apiKeyAn authorized api key
idTrafficSourceRetrieve a traffic source by its id › Responses
The requested traffic source
idTrafficSouce64-bit traffic source id; caller-generated for POST create (same pattern as other entities).
trafficSourceNameTraffic source's name. 255 characters max.
costTypedefaultCostThe tracking field names and their associated default tokens
categoryNameRead-only category name.
isArchivedRetrieve a traffic source by its name
Retrieve a traffic source by its name
query Parameters
apiKeyAn authorized api key
nameRetrieve a traffic source by its name › Responses
The requested traffic source
idTrafficSouce64-bit traffic source id; caller-generated for POST create (same pattern as other entities).
trafficSourceNameTraffic source's name. 255 characters max.
costTypedefaultCostThe tracking field names and their associated default tokens
categoryNameRead-only category name.
isArchivedRetrieve all traffic sources with the specified status
Retrieve all traffic sources with the specified status
query Parameters
apiKeyAn authorized api key
statusRetrieve all traffic sources with the specified status › Responses
List of traffic sources with the specified status
idTrafficSouce64-bit traffic source id; caller-generated for POST create (same pattern as other entities).
trafficSourceNameTraffic source's name. 255 characters max.
costTypedefaultCostThe tracking field names and their associated default tokens
categoryNameRead-only category name.
isArchivedUpdate an existing traffic source
Update an existing traffic source. The id cannot be changed.
query Parameters
apiKeyAn authorized api key
Update an existing traffic source › Request Body
idTrafficSouce64-bit traffic source id; caller-generated for POST create (same pattern as other entities).
trafficSourceNameTraffic source's name. 255 characters max.
costTypedefaultCostThe tracking field names and their associated default tokens
categoryNameRead-only category name.
isArchivedUpdate an existing traffic source › Responses
Traffic source updated successfully
Create a new traffic source
Create a new traffic source
query Parameters
apiKeyAn authorized api key
Create a new traffic source › Request Body
idTrafficSouce64-bit traffic source id; caller-generated for POST create (same pattern as other entities).
trafficSourceNameTraffic source's name. 255 characters max.
costTypedefaultCostThe tracking field names and their associated default tokens
categoryNameRead-only category name.
isArchivedCreate a new traffic source › Responses
Traffic source created successfully
Get a lightweight list of traffic sources with default cost data
Get a lightweight list of traffic sources with default cost data
query Parameters
apiKeyAn authorized api key
archivedLegacy archive filter. If true, return archived traffic sources only; if false, return active traffic sources only.
statusFilter traffic sources by status. Takes precedence over archived.
includeOrganicIf true, include organic traffic
Get a lightweight list of traffic sources with default cost data › Responses
List of traffic sources
idnameisArchivedstatuscategoryIdcategoryNamepageTypeidCampaigncampaignNamedefaultCostPerEntrancecostTypeClone an existing traffic source
Clone an existing traffic source
query Parameters
apiKeyAn authorized api key
idTrafficSourceThe id of the traffic source to clone
Clone an existing traffic source › Responses
The cloned traffic source
idnameisArchivedstatuscategoryIdcategoryNamepageTypeidCampaigncampaignNamedefaultCostPerEntrancecostTypeArchive or unarchive traffic sources in bulk
Delete multiple traffic sources in bulk
Delete multiple traffic sources in bulk
query Parameters
apiKeyAn authorized api key
Delete multiple traffic sources in bulk › Responses
Bulk delete result
successprocessederrors