Report

Report Resource

This is an object representing a report on a Batch. You can create a report by triggering report creation on a batch by using endpoint /batches/{BATCH_ID}/report/. The report is generated for the whole batch tree hierarchy and not only for direct sub-batches.

You can retrieve it to see the information of the report.

ENDPOINTS

GET /v1/reports/

GET /v1/reports/{REPORT_ID}/

GET /v1/reports/{REPORT_ID}/items/

DELETE /v1/reports/{REPORT_ID}/

Attributes

Top level attributes

Name	Type	Description
id	string	Global identifier to access the actual resource
title	string	Title for the report
type	string	Type of report (Available: diversity)
state	string	Status of the report creation (Available: waiting, processing, completed, failed)
error_msg	string	Error message while creation of the report. Can be null.
time_created	string	Creation time of the report (ISO Time String)

JSON Example

The following JSON snippet is showing a report object.

{
  "id": "8d3e24ce-a422-4de2-bcf2-2fc135ac1abf",
  "title": "Report of top-level on 09.03.2023",
  "time_created": "2023-03-09T12:54:49.076399Z",
  "type": "diversity",
  "state": "completed",
  "error_msg": null
}

ReportItem Resource

A Report refers to a collection of ReportItem, which are generated when report creation is triggered for a batch. Each report item summarizes the results of all jobs that ran within their batch and sub-batches in accordance with their tree hierarchy.

You can retrieve it to see the information of the report.

Attributes

Top level attributes

Name	Type	Description
content	dict	Report item data

Attributes of content

Name	Type	Description
batch_id	string	Global identifier to access the batch
report_info	DiversityInfo	Aggregated summarized results of a batch

JSON Example

The following JSON snippet is showing a report's all report items.

{
  "total": 3,
  "next": null,
  "prev": null,
  "limit": 10,
  "offset": 0,
  "data": [
    {
      "content": {
        "batch_id": "46c1d2ff-8e1c-4843-9b6d-71290dd75ec7",
        "report_info": {
          "gender_count": {
            "female": 1
          },
          "age_count": {
            "20-30": 1
          },
          "person_screen_time": {
            "female_1": 8.64
          },
          "gender_screen_time": {
            "female": 8.64
          },
          "age_screen_time": {
            "20-30": 8.64
          },
          "gender_speech_time": {
            "female": 8.64
          },
          "age_speech_time": {
            "20-30": 8.64
          },
          "name_to_speech_time": {
            "female_1": 8.64
          }
        }
      }
    },
    {
      "content": {
        "batch_id": "bb6e8a36-4b94-4dda-9428-746c2e91bc3a",
        "report_info": {
          "gender_count": {
            "male": 4,
            "female": 2
          },
          "age_count": {
            "30-40": 5,
            "20-30": 1
          },
          "person_screen_time": {
            "male_1": 14.0,
            "male_2": 19.0,
            "female_1": 7.0,
            "female_2": 3.5
          },
          "gender_screen_time": {
            "male": 33.0,
            "female": 10.5
          },
          "age_screen_time": {
            "30-40": 36.5,
            "20-30": 7.0
          },
          "gender_speech_time": {
            "male": 17.0,
            "female": 3.5
          },
          "age_speech_time": {
            "30-40": 20.5,
            "20-30": 0
          },
          "name_to_speech_time": {
            "male_1": 0,
            "male_2": 17.0,
            "female_1": 0,
            "female_2": 3.5
          }
        }
      }
    },
    {
      "content": {
        "batch_id": "c47859ee-a39d-45ed-ad54-8e6ba060be80",
        "report_info": {
          "gender_count": {
            "female": 3,
            "male": 4
          },
          "age_count": {
            "20-30": 2,
            "30-40": 5
          },
          "person_screen_time": {
            "female_1": 15.64,
            "male_1": 14.0,
            "male_2": 19.0,
            "female_2": 3.5
          },
          "gender_screen_time": {
            "female": 19.14,
            "male": 33.0
          },
          "age_screen_time": {
            "20-30": 15.64,
            "30-40": 36.5
          },
          "gender_speech_time": {
            "female": 12.14,
            "male": 17.0
          },
          "age_speech_time": {
            "20-30": 8.64,
            "30-40": 20.5
          },
          "name_to_speech_time": {
            "female_1": 8.64,
            "male_1": 0,
            "male_2": 17.0,
            "female_2": 3.5
          }
        }
      }
    }
  ]
}