List financial metrics

https://api.codat.io/data/companies/{companyId}/connections/{connectionId}/assess/financialMetrics

Gets all the available financial metrics for a given company, over one or more periods.

Access Token Required: API Key

Query Params

showMetricInputsboolean

If set to true, then the system includes the input values within the response.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.codat.io/data/companies/{companyId}/connections/{connectionId}/assess/financialMetrics' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET