Get performance metrics of a matched merchant
GET {{baseUrl}}/metrics/:location_id?has_consent=true
Returns a large set of varied metrics for a given merchant that can be used to inform lending decisions.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
has_consent | boolean | (Required) A boolean indicating that the user of this API has consent to pull these metrics for the requested merchant |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"locationId":"00000000-0000-0000-0000-000000000001","merchantCategoryCode":478,"naicsCode":"minim proident","industryName":"Arts and Craft Stores","firstSeenTxnDate":"2021-01-01","lastSeenTxnDate":"2021-12-31","metricsLists":[{"periodStartDate":"2021-01-01","periodEndDate":"2021-01-07","year":2021,"metrics":[{"name":"txn_amt","value":234.567890123},{"name":"txn_cnt","value":5}]},{"periodStartDate":"2022-01-09","periodEndDate":"2022-01-15","year":2022,"metrics":[{"name":"txnAmt","value":123.456789012},{"name":"txnCnt","value":3}]}]}