Download OpenAPI specification:Download
Each request to Discovery API must be authorized with the api-key header associated with the provided key.
sort | string Default: "relevance" Enum: "date" "relevance" Search results sort critera |
offset | integer <int32> Default: 0 Number of search result items to skip (for pagination) |
limit | integer <int32> Default: 10 Number of search result items to return |
query required | string Main query of the request |
itemTypes | string Default: "article" Enum: "article" "page" Type of search |
author | string Author filter |
countries required | Array of strings[ items = 2 characters ] Countries filter |
cids | Array of strings[ items = 4 characters ] Publications filter (CIDs) |
languages | Array of strings[ items = 2 characters ] Language filter |
searchIn | string Default: "everywhere" Enum: "everywhere" "body" "header" SearchIn filter |
startDate | string <date> Start date filter |
endDate | string <date> End date filter |
{- "query": "string",
- "itemTypes": "article",
- "author": "string",
- "countries": [
- "US"
], - "cids": [
- "0001"
], - "languages": [
- "en"
], - "searchIn": "everywhere",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}
{- "items": [
- {
- "publication": {
- "cid": "string",
- "title": "string",
- "countries": [
- "string"
], - "language": "string",
- "publicationType": "string",
- "url": "string"
}, - "issue": {
- "date": "2019-08-24",
- "url": "string"
}, - "page": {
- "number": 0,
- "url": "string"
}, - "article": {
- "id": 0,
- "title": "string",
- "subTitle": "string",
- "author": "string",
- "authors": [
- {
- "id": 0,
- "name": "string"
}
], - "copyright": "string",
- "media": [
- {
- "type": "unknown",
- "typeName": "unknown",
- "title": "string",
- "author": "string",
- "height": 0,
- "width": 0,
- "url": "string",
- "thumbnailUrl": "string"
}
], - "url": "string"
}, - "summary": "string",
- "categories": [
- {
- "id": 0,
- "name": "string"
}
], - "entities": [
- {
- "id": 0,
- "weight": 0,
- "name": "string",
- "sentiment": "string"
}
], - "sentiment": "string"
}
], - "meta": {
- "totalCount": 0,
- "offset": 0,
- "limit": 0
}
}
Search Request description markdown.
query | string |
sort | string Enum: "Relevance" "ScDate" "SCreator" "STitle" "Popularity" "Date2" Search results sort critera |
from | integer <int32> Default: 0 Number of search result items to skip (for pagination) |
bulksize | integer <int32> Default: 10 Number of search result items to return |
[object Object]
{- "docs": [
- {
- "control": {
- "sourceRecordId": [
- "string"
], - "sourceId": [
- "string"
], - "recordId": [
- "string"
]
}, - "display": {
- "type": [
- "string"
], - "title": [
- "string"
], - "creator": [
- "string"
], - "language": [
- "string"
], - "description": [
- "string"
], - "creationDate": [
- "string"
]
}, - "delivery": {
- "fullText": [
- "string"
], - "delCategory": [
- "string"
]
}
}
], - "facets": [
- {
- "name": "string",
- "values": [
- {
- "value": "string",
- "count": 0
}
]
}
], - "info": {
- "total": 0,
- "last": 0,
- "first": 0
}
}