Export Summary

GET

/api/v1/export/summary

const url = 'https://example.com/api/v1/export/summary';
const options = {method: 'GET'};

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/api/v1/export/summary

Return export summary metadata for preview.

Returns row_count (unique dates), account_count (active accounts), date_from (earliest ISO date or None), date_to (latest ISO date or None).

Responses

200

Successful Response

application/json

ExportSummary

Summary metadata for export preview.

object

row_count

required

Row Count

integer

account_count

required

Account Count

integer

date_from

required

Any of:

string
null

string

date_to

required

Any of:

string
null

string

Example ^generated

{
  "row_count": 1,
  "account_count": 1,
  "date_from": "example",
  "date_to": "example"
}

Export Summary

Responses

200

Example generated

Example ^generated