Reporting APIs

10/29/2020 Contributors Download PDF of this page

Use the methods in the following table to retrieve and generate reports.

HTTP Method Path Description

HTTP Method	Path	Description
`GET`	`/v2.1/reports`	Retrieve all list of reports.
`POST`	`/v2.1/reports/{filename}`	Retrieve a report.

GET

/v2.1/reports

Retrieve all list of reports.

POST

/v2.1/reports/{filename}

Retrieve a report.

Retrieve a list of reports

Use the method listed in the following table to retrieve a list of reports.

HTTP Method Path Description Parameters

HTTP Method	Path	Description	Parameters
`GET`	`/v2.1/reports`	Retrieve all available reports for a tenant. Reports can be filtered by date range.	`tenant_id (string)` `start(string)`: Retrieve reports more recent that the date specified in start. `end (string)`: Retrieve reports older that the date specified in end.

GET

/v2.1/reports

Retrieve all available reports for a tenant.
Reports can be filtered by date range.

tenant_id (string)
start(string): Retrieve reports more recent that the date specified in start.
end (string): Retrieve reports older that the date specified in end.

Required request body attributes: none

Request body example:

none

Response body example:

{
  "status": {
    "user_message": "string",
    "verbose_message": "string",
    "code": "string"
  },
  "result": {
    "returned_records": 1,
    "records": [
      {
        "filename": "string"
      }
    ]
  }
}

Retrieve a report identified by file name

Use the method in the following table to retrieve a report identified by the file name.

HTTP Method Path Description Parameters

HTTP Method	Path	Description	Parameters
`GET`	`/v2.1/reports/{filename}`	Retrieve a report identified by the file name.	`filename (string)`: The report file name.

GET

/v2.1/reports/{filename}

Retrieve a report identified by the file name.

filename (string): The report file name.

Required request body attributes: none

Request body example:

none

Response body example:

{
  "status": {
    "user_message": "string",
    "verbose_message": "string",
    "code": "string"
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "filename": "string"
      }
    ]
  }
}