List of Concepts
GET {{campaign_url}}/concepts?marketId=1&advertiserId&conceptUsage=brandSafety&conceptUsageSubtype=interests&offset=0&limit=2&sortOrder=desc&sortKey=id
Retrieve a list of concepts
You can retrieve all or a subset of the concepts 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, 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 concepts within the market specified (if you have access to multiple markets). |
Cannot be defined when advertiserId is defined. |
| advertiserId
| null | | Limits response results to concepts under the advertiser specified. If left unchecked/empty, concepts for all advertisers are returned.
Cannot be defined when marketId is defined. |
| conceptUsage
| string | | Usage type of the concepts to be returned.
Allowed values: contextual, pageQuality, brandSafety, location, amobeeBrandIntelligence, venue, contextualTarget |
| conceptUsageSubtype
| string | | Usage subtype of the concepts to be returned.
Allowed values: trends, topics, custom, keywords, customTrends, customKeywords, interests, lifeStages, audiences, seasonal, brands, smartTV, customSmartTV |
| offset
| number | | The starting index in the list of concept objects. |
| limit
| number | | The number of concepts 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":557,"data":[{"id":"1165179641","marketId":"1","resourceType":"concept","workflowStatus":"approved","contentProviderId":"1161299458","createdAt":"2020-04-09T13:32:16Z","updatedAt":"2021-03-11T07:17:37Z","cost":0,"currency":"usd","name":"Test Concept","conceptUsage":"amobeeBrandIntelligence","conceptUsageSubtype":"interests","advertiserIds":["1234"]},{"id":"1164612541","marketId":"1","resourceType":"concept","workflowStatus":"approved","contentProviderId":"1161160131","createdAt":"2019-05-23T11:18:18Z","updatedAt":"2019-05-23T12:00:13Z","cost":0,"currency":"usd","name":"BI Test","conceptUsage":"amobeeBrandIntelligence","conceptUsageSubtype":"interests","advertiserIds":["1234"]}],"errors":[],"links":{"self":"https://services.amobee.com/campaign/v5/api/concepts?advertiserId=1606973956\u0026conceptUsage=brandSafety\u0026conceptUsageSubtype=interests\u0026offset=0\u0026limit=2\u0026sortOrder=desc\u0026sortKey=id","next":"https://services.amobee.com/campaign/v5/api/concepts?advertiserId=1606973956\u0026conceptUsage=brandSafety\u0026conceptUsageSubtype=interests\u0026offset=2\u0026limit=2\u0026sortOrder=desc\u0026sortKey=id"}}