Webex · Schema

Report

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for the report.
title	string	Name of the template to which this report belongs.
service	string	The service to which the report belongs.
startDate	string	The data in this report belongs to dates greater than or equal to this.
endDate	string	The data in this report belongs to dates smaller than or equal to this.
siteList	string	The site to which this report belongs to. This only exists if the report belongs to service `Webex`.
created	string	Time of creation for this report.
createdBy	string	The person who created the report.
scheduledFrom	string	Whether this report was scheduled from API or Control Hub.
status	string	Completion status of this report.
downloadURL	string	The link from which the report can be downloaded.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Report",
  "title": "Report",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
      "description": "Unique identifier for the report."
    },
    "title": {
      "type": "string",
      "example": "Bots Activity",
      "description": "Name of the template to which this report belongs."
    },
    "service": {
      "type": "string",
      "example": "Teams",
      "description": "The service to which the report belongs."
    },
    "startDate": {
      "type": "string",
      "example": "2020-02-23",
      "description": "The data in this report belongs to dates greater than or equal to this."
    },
    "endDate": {
      "type": "string",
      "example": "2020-03-24",
      "description": "The data in this report belongs to dates smaller than or equal to this."
    },
    "siteList": {
      "type": "string",
      "example": "cisco.webex.com",
      "description": "The site to which this report belongs to. This only exists if the report belongs to service `Webex`."
    },
    "created": {
      "type": "string",
      "example": "2020-03-24 17:13:39",
      "description": "Time of creation for this report."
    },
    "createdBy": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
      "description": "The person who created the report."
    },
    "scheduledFrom": {
      "type": "string",
      "example": "API",
      "description": "Whether this report was scheduled from API or Control Hub."
    },
    "status": {
      "type": "string",
      "example": "done",
      "description": "Completion status of this report."
    },
    "downloadURL": {
      "type": "string",
      "example": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
      "description": "The link from which the report can be downloaded."
    }
  }
}