CDAPI Stores
The CDAPI has 3
stores, which between them hold all the metadata that Simply.TV provides to its customers:
- Content Instance: This store holds details about series, programs, events etc. The full program hierarchy is explained here.
- Contributor: This store holds details about actors, directors etc.
- Source: This store holds details about linear channels and VOD catalogs.
Each store is a collection of JSON documents, with one document per program, contributor etc.
The filter request
The most common request to the CDAPI is via the
filter resource. Its basic syntax is as follows:
https://<ApiEndpoint>/stores-active/<StoreType>/filter?filter=<FilterCriteria>&api_key=<ApiKey>
The payload of the CDAPI’s response will be an array of JSON documents, which will be a set of documents taken from the specified store that meet the specified criteria.
All the documents in one store (and hence all the documents in a response to a filter request) have the same schema, but the schema for the 3 stores is different to reflect the different data they hold. Further explanation can be found by following the relevant link below:
Other CDAPI Responses
The API offers several other resources. Some (like
entitlements) give you more precise control over what data is returned; others (like
deleted-documents) support use cases beyond retrieving API data. Details of these requests, together with the responses they produce, can be found on child pages of the
CDAPI Requests page.
