Reports API Version 2 Currencies
Introduction
The currencies section of the report API allows you to read the currencies that have been used for this IGRP for transactions and goals.
List Currencies
Returns a list of all currencies that have been seen for the given IGRP.
Request:
GET /reports/v2/igrps/{IGRP SPECIFIER}/currencies
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
GET Params
- filter (array) OPTIONAL - One or more filters.
- group (array) OPTIONAL - One or more group params.
- sort (array) OPTIONAL - One or more sorting params.
- limit (integer) OPTIONAL - Limit on the result set.
- offset (integer) OPTIONAL - Offset on the result set.
Filter Types
- currencyField (string) - Currency Field (either goalCurrency or txc)
- currencyCode (string) - Currency Code (three-letter ISO-4217 currency code, e.g. GBP)
Sort Types
Same as Filter Types
Group Types
Same as Filter Types
Response:
All currencies seen for this IGRP.
- currencyField (string) - Currency Field (either goalCurrency or txc)
- currencyField (string) - Currency Code (three-letter ISO-4217 currency code, e.g. GBP)