List of Concept Sets
GET {{campaign_url}}/conceptSets?marketId=1&advertiserId=&conceptUsage=contextual&isReusable=true&offset=0&limit=2&sortOrder=asc&sortKey=name
Retrieve a list of concept sets
You can retrieve all or a subset of the concept sets within a specified market or advertiser by sending this GET
request.
Note: If you have access to multiple markets, you must specify a value for marketId
. Otherwise (i.e., marketId
is left unchecked), the request will return a 300 Multiple Choices response containing a list of market IDs that can be passed as marketId
values.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
marketId | number | Limits response results to concept sets within the market specified (if you have access to multiple markets). |
Cannot be defined when advertiserId is defined. |
| advertiserId
| null | | Limits response results to concept sets under the advertiser specified. If left unchecked/empty, concept sets for all advertisers are returned.
Cannot be defined when marketId is defined. |
| conceptUsage
| string | | Usage type of the concept sets to be returned.
Allowed values: contextual, pageQuality, brandSafety, location, amobeeBrandIntelligence, venue, contextualTarget |
| isReusable
| boolean | | Limits response results to only concept sets that are either reusable or non-reusable.
Allowed values: true, false |
| offset
| number | | The starting index in the list of concept set objects. |
| limit
| number | | The number of concept sets to return. |
| sortOrder
| string | | Direction by which results should be sorted.
Allowed values: asc, desc |
| sortKey
| string | | Field by which results should be sorted.
Allowed values: id, name |
RESPONSES
status: OK
{"queryTotal":64,"data":[{"id":"1629213433","marketId":"1","resourceType":"conceptSet","name":"Brand Safety 2022","advertiserIds":["1606982665"],"workflowStatus":"approved","createdAt":"2022-06-02T15:53:01Z","updatedAt":"2022-06-02T15:53:01Z","conceptUsage":"brandSafety","isReusable":true},{"id":"1629212418","marketId":"1","resourceType":"conceptSet","name":"Brand Safety 2022 Ver2","advertiserIds":["1606982665"],"workflowStatus":"approved","createdAt":"2022-06-02T16:01:02Z","updatedAt":"2022-06-02T16:01:02Z","conceptUsage":"brandSafety","isReusable":true}],"errors":[],"links":{"self":"https://services.amobee.com/campaign/v5/api/conceptSets?marketId=1\u0026conceptUsage=brandSafety\u0026isReusable=true\u0026offset=0\u0026limit=2\u0026sortOrder=desc\u0026sortKey=id","next":"https://services.amobee.com/campaign/v5/api/conceptSets?marketId=1\u0026conceptUsage=brandSafety\u0026isReusable=true\u0026offset=2\u0026limit=2\u0026sortOrder=desc\u0026sortKey=id"}}