Client Web Property Search Volume Report
GET URL
GET v3/{accountId}/web-properties/{clientWebPropertyId}/rank-sources/{rankSourceId}/tp/{timePeriodId}/search-volumes
Description
Returns a list of all tracked keywords for a given web property; the average monthly search volume of the past 12 months for each tracked keyword; and the monthly search volume for each of the previous 12 months for each tracked keyword.
For example:
[{
"averageVolume": 1700,
"trackedSearchId": 3665365,
"volumeItems": [{
"volume": 2900,
"month": 7,
"year": 2015
}, {
"volume": 2100,
"month": 6,
"year": 2015
}, {
"volume": 1700,
"month": 5,
"year": 2015
}, {
"volume": 2100,
"month": 4,
"year": 2015
}, {
"volume": 2100,
"month": 3,
"year": 2015
}, {
"volume": 2100,
"month": 2,
"year": 2015
}, {
"volume": 1700,
"month": 1,
"year": 2015
}, {
"volume": 1100,
"month": 12,
"year": 2014
}, {
"volume": 1230,
"month": 11,
"year": 2014
}, {
"volume": 1700,
"month": 10,
"year": 2014
}, {
"volume": 1700,
"month": 9,
"year": 2014
}, {
"volume": 1850,
"month": 8,
"year": 2014
}]
}, {
"averageVolume": 20,
"trackedSearchId": 3665366,
"volumeItems": [{
"volume": 30,
"month": 7,
"year": 2015
}, {
"volume": 20,
"month": 6,
"year": 2015
}, {
"volume": 10,
"month": 5,
"year": 2015
}, {
"volume": 10,
"month": 4,
"year": 2015
}, {
"volume": 20,
"month": 3,
"year": 2015
}, {
"volume": 20,
"month": 2,
"year": 2015
}, {
"volume": 10,
"month": 1,
"year": 2015
}, {
"volume": 30,
"month": 12,
"year": 2014
}, {
"volume": 20,
"month": 11,
"year": 2014
}, {
"volume": 30,
"month": 10,
"year": 2014
}, {
"volume": 20,
"month": 9,
"year": 2014
}, {
"volume": 20,
"month": 8,
"year": 2014
}]
}]Parameters
accountId
The numeric identifier of a Conductor account. You can find this after logging into a Conductor account in the URL. Just go to Insight Stream: the numerical string in the URL represents the Account ID. For example:
https://app.conductor.com/5197/insight-stream
Required?: Yes
Type: String
webPropertyId
A web property’s numeric identifier string. This appears in the webPropertyId column of the Client Web Property Rank Report endpoint and appears in Conductor platform URLs that are specific to web properties. For example, in Explorer, the second numeric string represents the web property ID:
https://app.conductor.com/5197/web-properties/15350/rank-sources/1/explorer
Required?: Yes
Type: String
rankSourceId
The numeric identifier for the rank source.
This value also appears in the Rank Source List endpoint.
Required?: Yes
Type: String
timePeriodId
The timePeriodId determines the reporting time period in the Conductor platform associated with the data being called. Time period IDs can be inferred from URLs in the Conductor platform. For example, in the example URL below for the Keywords report, the report indicates that the time periods 686 and 687 are being compared. New time periods always take the next subsequent integer from the current time period (i.e. time period 687 is followed by time period 688, 688 by 689, and so on).
https://app.conductor.com/5197/keywords?rankType=TRUE_RANK&compareTP=686&reportTP=687&...
Required?: Yes
Type: String
Response
The response is a JSON-encoded array containing results representing twelve months of monthly search volume and the average search volume for each tracked keyword. Each has the following attributes:
averageVolume
The number of times people have searched for the tracked keyword each month, averaged over the last twelve months.
trackedSearchId
The numeric identifier of tracked keyword (active or inactive). This also appears in Tracked Search List endpoint’s and in the Conductor platform URL for a specific tracked keyword in the Keywords activity (Settings > Keywords). For example, the second numeric string represents the trackedSearchId:
https://app.conductor.com/admin/5197/searches/49988127
volumeItems
An array of objects describing this tracked keyword's last twelve months of search volume data, each having attributes:
- volume: The search volume reported for the associated month and year
- month: The month identifier of the data as represented by 1-12
- year: The year identifier of the data as represnted by YYYY
Try this endpoint with the interactive documentation