Analytics API

Enum

TabularDataFormat1

Output format for tabular analytics data.

Kind Enum type
Used in ListCollections1, ListCustomers3, ListDocuments3, ListHistory1, ListOrders3, ListProducts1, ListReferrals3

Values

  • jsonl

    JSON Lines: a stream of JSON objects, one object per line

    Recommended format for fast and easy parsing.

    You don't need a separate library for this, just split the input by lines and parse each one as JSON.

    See jsonlines.org for an exact spec, although it really is as simple as it sounds.

  • json

    JSON

    Note that the responses could be huge, so parsing might consume a lot of RAM.

  • csv

    CSV with comma as field separator, double quotes for quoting and empty/null values represented by an empty string

  • excel-csv

    Excel CSV: same columns and text/csv body as csv, with formula-safe text cells

    Numbers stay numbers, including negatives.

    Text cells and headers whose first character is =, +, -, @, tab, or CR get a leading apostrophe.

Previous
RedemptionStatus1