GET /reports/{report_id}

Get report details by ID.

Adress: GET https://instance_name/api/v1.5/reports/{report_id}/

Content-type: application/json

Path parameters​

---

report_id integer

Required. Report ID.

---

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/data/v1.5/reports/1786/ 
  -H ‘Authorization: Token <<your_token>>’

Response example

Response code: 200

{
  "id": 1786,
  "status": "READY",
  "created_date": "2016-08-31КT10:32:15.687287Z",
  "report_type": "FACING_COUNT",
  "json": {
    // ... 
  }
}

Response definitions

---

id string

Report ID.

---

status string

Report status.

• «NOT_READY» — the report in the process of preparation. The client must repeat the request later.

• «READY» — the report was successfully prepared. The client can use the «data» field.

• «ERROR» — error in the process of preparing the report. The error message is available in the «error» field.

---

report_type string

Type of report.

---

For reports with the status READY

---

created_date string (date-time)

Date the report was created in the format «YYYY-MM-DDTHH:MM:SSZ».

---

previous_report string (report ID)

ID of the previous report with the same type, display and customer_id or null.

json Object

Report data. The schema depends on the report type.

---

For reports with the status ERROR

---

error string

Error message.

---