Output formats

The Supermetrics API supports several output formats for extracting query data. Each format has its own dedicated endpoint, available for get data queries.

• JSON (default)

• Records JSON (key-value pairs)

• Newline delimited JSON (NDJSON/JSONL/JSON Lines)

• Parquet (Preview)

• Qlik

• Tableau

• CSV

• TSV

• Limitations

• Missing a format?

JSON (default)

The default output format of the Supermetrics API is JSON. The response is a single JSON object containing a meta envelope (request details, resolved query, field definitions, result summary and pagination) and a data field.

data is returned as an array of arrays: the first inner array is the header row (field names), and each subsequent inner array is a data row in the same column order. See get data for the full response structure and examples.

Endpoints

Settings

• no_json_keys setting is by default true

• Optional setting decode_json_fields

Features

• Supports result pagination

• Supports field's key-property

Records JSON (key-value pairs)

Output format for query results in JSON without any metadata. Data is returned as an array of record objects (the "records" orientation), where each object represents one data row and its keys are the requested field id values. This row-oriented structure is understood by a wide range of solutions, including Excel and Azure Logic Apps.

This format is also referred to as key-value pairs JSON. The endpoint suffix remains keyjson for backward compatibility.

Endpoints

Settings

• no_headers setting is by default true

• Optional setting no_json_keys

• Optional setting decode_json_fields

Features

• Supports field's key-property

Newline delimited JSON (NDJSON / JSONL / JSON Lines)

This output format implements the NDJSON specification for line separated JSON (also known as JSON Lines or JSONL). Thr response consists only of the query results, where each new line is a single row of data. Each data row is structured as a JSON object, where keys are the requested field id values.

This form of JSON streaming is preferred by some systems, such as BigQuery and Azure Data Factory.

Endpoints

Settings

• no_headers setting is by default true

• Optional setting no_json_keys

• Optional setting decode_json_fields

Features

• Supports result pagination

• Supports field's key-property

Parquet (Preview)

Output format to get query results as a Apache Parquet file – columnar data storage format used in Apache Hadoop. Generated file is configured for Parquet version 1.0.

Parquet files are supported by various data processing services, such Azure Data Factory.

Please note that this output format is in Preview and it might not work for all queries, or for all services that accept Parquet files. Please let us know of any issues you might encounter to help us improve this output format.

Endpoints

Settings

• clean_numeric_types setting is by default true

• dimensions_to_strings setting is by default true

• Optional setting decode_json_fields

Features

• Supports result pagination

• Supports field's key-property

Qlik

Output format designed for integrations with Qlik Sense. Please see related solution article on how to get started.

Endpoints

Tableau

Output format designed for integrations with Tableau. following the structure expected by the Tableau Web Data Connector. The response is a JSON object containing:

• schema – table metadata, including a columns array where each column exposes its id, alias, columnRole dimension or measure) and dataType.

• rows – the query results, where the first row is the header and subsequent rows are data.

• format – the format identifier (Tableau).

Endpoints

CSV

Output format as a CSV file, following RFC 4180. Default delimiter is a comma and enclosing character is a quotation mark, when necessary. This format can also be used when fetching data into Excel.

Endpoints

TSV

Output format as a TSV file, following RFC 4180. Default delimiter is a tab and enclosing character is a quotation mark, when necessary. This format can also be when fetching data into Excel.

Endpoints

Limitations

• Unless otherwise mentioned, output formats do not support pagination

• Output formatting only applies to successfully executed queries. If an error occurs, the response uses the standard JSON error response

Missing a format?

If you find that we are missing the output format you absolutely need, please contact us or your Supermetrics representative, and let us know.