Category List (Keyword Groups)

GET URL

GET v3/accounts/{accountId}/categories

Description

Returns a list of an account's active keyord groups (formerly called categories) and their constituent tracked keywords (formerly called searches).

For smart keyword groups this endpoint returns all current tracked keywords at the time of endpoint engagement.

For example:

[{
    "created": "2015-01-01T17:58:07.000Z",
    "trackedSearchIds": [123456],    
    "modified": "2015-01-01T17:58:07.000Z",    
    "name": "Foo"
}, {
    "created": "2015-01-01T17:58:07.000Z",    
    "trackedSearchIds": [789012, 34567],    
    "modified": "2015-06-21T23:25:34.000Z",    
    "name": "Bar"
}, { 
    "created": "2015-01-08T17:58:07.000Z",    
    "trackedSearchIds": [123456, 789012, 34567, 9999999],    
    "modified": "2015-08-01T12:00:00.000Z",    
    "name": "All Keywords Example"
}]

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

Response

The response is a JSON-encoded array containing objects representing the account’s configured, currently active keyword groups. Each has the following attributes:

created

Date the keyword group was created.  All date values are in YYYYMMDD format.

trackedSearchIds

An array of the tracked keywords (active or inactive) that are members of the keyword group.

modified

The most recent date the keyword group was modifed. All date values are in YYYYMMDD format.

name

The name associated in the platform with the keyword group.


Try this endpoint with the interactive documentation