Skip to main content

GET /reports

Retrieves a list of all available reports.

Reports are JSON documents created for a scene based on recognized images and, optionally, pre-loaded display master data such as a planogram. The system provides small set of basic report types at all instances, though it is not uncommon to implement custom report types based on specific client requirements. These custom reports are available on specific instances only and are documented elsewhere.

Adress: GET https://instance_name/api/v1.5/reports/

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/v1.5/reports/ 
  -H ‘Authorization: Token your_token’
  -F "limit=2" \
  -F "offset=0"

Response example

The response to the request returns a list of available reports with the ID's. Detailed information about the report can be viewed via /reports/{report_id}.

Response code: 200

{
  "count": 125455,
  "next": "http://example.com",
  "previous": null,
  "results": [
    {
      "id": 1595,
      "status": "READY",
      "report_type": "REALOGRAM",
      "created_date": "2020-07-03T15:28:08.128466Z",
      "updated_date": "2020-07-03T15:28:08.128486Z",
      "visit": 13
    },
    {
      "id": 1596,
      "status": "READY",
      "report_type": "MUST_HAVE_SKU",
      "created_date": "2020-07-03T15:28:08.189385Z",
      "updated_date": "2020-07-03T15:28:08.189408Z",
      "visit": 13
    }
  ]
}

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.

created_date string (date-time)

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

updated_date string (date-time)

Дата обновления данных в отчете в формате «ГГГГ-ММ-ДДTЧЧ:ММ:ССZ».

Date of information update in the report in the format «YYYY-MM-DDTHH:MM:SSZ».

visit string

Visit ID.