Tracked Searches

GET v3/accounts/{accountId}/web-properties/{webPropertyId}/tracked-searches

Returns a list of all of a client web property's configured tracked keyword searches, for use when interpreting the Client Web Property Rank Report.

For example:

[{
    "isActive": true,
    "trackedSearchId": "3665365",
    "preferredUrl": "http://us.yoyodyne.com/products/fasteners/",
    "queryPhrase": "pop rivets",
    "locationId": "1",
    "rankSourceId": "1",
    "deviceId": "1"
}, {
    "isActive": true,
    "trackedSearchId": "3665366",
    "preferredUrl": "http://us.yoyodyne.com/home/community-relations/",
    "queryPhrase": "San Narciso Chamber of Commerce",
    "locationId": "3242",
    "rankSourceId": "1",
    "deviceId": "2"
}, {
    "isActive": false,
    "trackedSearchId": "3665367",
    "preferredUrl": "http://us.yoyodyne.com/products/elastomers/polybutadiene.htm",
    "queryPhrase": "polybutadiene",
    "locationId": "1",
    "rankSourceId": "1",
    "deviceId": "1"
}]

The response is a JSON-encoded array of tracked tracked search objects configured under the selected client web property, each having the following attributes:

trackedSearchId The tracked search’s opaque identifier string, which also appears in the Client Web Property Rank Report’s trackedSearchId column.
queryPhrase 
 A keyword search phrase string.
rankSourceId The id of the rank source being tracked. This value comes from the Rank Source List.
locationId The id of the location being tracked. This value comes from the Location List.
deviceId The id of the device type being tracked. This value comes from the Device List.
isActive Boolean which indicates whether the tracked search is active in Searchlight.

Try this endpoint with the interactive documentation.

version 5 as of 5 years ago by pmorgan