Content Output Templates
Output templates control the shape of the data returned by the API for export, search and streaming features. You specify a template by setting the template field on your request.
Available templates
| Template | Code | Formats | Supported by |
|---|---|---|---|
| API JSON | api.json | JSON | Listening API exports, Listening API streaming, Explore+ API search |
| Popular Fields & Metrics | app.standard | CSV, XLSX | Listening API exports |
| Legacy JSON | (default when no template is specified) | JSON | Listening API exports, Listening API streaming |
| Legacy CSV | (default when no template is specified) | CSV | Listening API exports |
Choosing a template
- Building a JSON integration? For most cases use API JSON. It includes all the fields most customers need and is supported across Listening exports, Listening streaming, and Explore+ search.
- Pulling data into a spreadsheet or BI tool? For most cases use Popular Fields & Metrics.
- Maintaining an older integration? Legacy JSON and Legacy CSV are what you receive if no
templatefield is specified, depending on the output format you request. We recommend migrating to API JSON or Popular Fields & Metrics for new work.
Conventions used across all templates
- All returned strings are encoded using UTF-16.
- All datetime values are output in ISO-8601 format, in UTC timezone.
- Output for News documents is subject to copyright restrictions.
- Fields marked Explore+ only are only applicable to output from the Explore+ API.
- Fields marked Exports only are not available in streaming output.