Retrieve MDR request status

GET 
/reporting/mdr_requests/:id

Retrieve the status of an MDR request. Response includes a link to the report once it is generated.

Request

Path Parameters

id stringrequired

ID of MDR Request to retrieve

Responses

200: mdr_request

application/json

• Schema
• Example (from schema)

Schema

id stringrequired
start_time stringrequired

UTC (2024-04-10T00:00:00+00:00)

end_time stringrequired

UTC (2024-04-10T12:09:59+00:00)

call_types integer[]required

Default value: 1

Inbound = 1, Outbound = 2

record_types integer[]required

Default value: 1

Complete = 1, Incomplete = 2, Errors = 3

connections string[]required

Array of connection IDs

report_name stringrequired
status integerrequired

Default value: 1

Pending = 1, Complete = 2, Failed = 3, Expired = 4

report_url stringrequired

Link to report

filters stringrequired

Search criteria

created_at stringrequired
updated_at stringrequired
profiles string

{
  "id": "string",
  "start_time": "string",
  "end_time": "string",
  "call_types": [
    0
  ],
  "record_types": [
    0
  ],
  "connections": [
    "string"
  ],
  "report_name": "string",
  "status": 1,
  "report_url": "string",
  "filters": "string",
  "created_at": "string",
  "updated_at": "string",
  "profiles": "string"
}

401: Unauthorized

404: Resource not found

Loading...