Export the reporting overview

GET

/reports/overview.csv

const url = 'https://example.com/reports/overview.csv?period=today&comparison=true';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/reports/overview.csv?period=today&comparison=true' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

sessionCookie
reports:read
apiKey
reports:read

Parameters

Query Parameters

period

string

default: thirtyDays

Allowed values: today workingWeek sevenDays currentMonth thirtyDays currentQuarter custom

from

string format: date

comparison

boolean | null

default: true

Responses

200

CSV export

text/csv

string

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not allowed

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}