Skip to main content
GET
/
information-reports
/
Get information reports
curl --request GET \
  --url https://api.standardmetrics.io/v1/information-reports/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "company_id": "<string>",
      "submitted_at": "2023-11-07T05:31:56Z",
      "information_request_id": "<string>",
      "documents": [
        {
          "id": "<string>",
          "status": "<string>",
          "requested_document": "<string>"
        }
      ],
      "documents_completed": "<string>",
      "documents_missing": "<string>",
      "metrics": [
        {
          "id": "<string>",
          "date": "<string>",
          "name": "<string>",
          "status": "<string>",
          "time_period": "<string>"
        }
      ],
      "metrics_completed": "<string>",
      "metrics_missing": "<string>",
      "status": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Query Parameters

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

company_id
string

ID of a company to filter

information_request_id
string

ID of an Information Request to filter

Response

200 - application/json
count
integer
required
results
object[]
required
next
string<uri> | null
previous
string<uri> | null
I