{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Partner Reports/Templates API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Partner Reports/Templates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/reports",
            "params": [
              {
                "name": "service",
                "value": "Webex",
                "type": "query",
                "description": "List reports which use this service."
              },
              {
                "name": "templateId",
                "value": "5",
                "type": "query",
                "description": "List reports with this report template ID."
              },
              {
                "name": "from",
                "value": "2024-05-01",
                "type": "query",
                "description": "List reports that were created on or after this date."
              },
              {
                "name": "to",
                "value": "2024-05-05",
                "type": "query",
                "description": "List reports that were created before this date."
              },
              {
                "name": "regionId",
                "value": "US",
                "type": "query",
                "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n<div><Callout type=\"info\">CSV reports for Webex suite services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.</C"
        },
        {
          "info": {
            "name": "Create a Report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/partner/reports",
            "params": [
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new report. A new report can be created using `templateId` available from the _List Report Templates_ API. For each `templateId`, there are a set of validation rules that need to be followed.\n\nThe `templateId` parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` and `identity:people_read` scopes"
        },
        {
          "info": {
            "name": "Get Report Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/reports/:reportId",
            "params": [
              {
                "name": "reportId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
                "type": "path",
                "description": "The unique identifier for the report."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Shows details for a report by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n**Notes**:\n\n<div><Callout type=\"info\">Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.</Callout></div>"
        },
        {
          "info": {
            "name": "Delete a Report",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/partner/reports/:reportId",
            "params": [
              {
                "name": "reportId",
                "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
                "type": "path",
                "description": "The unique identifier for the report."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` scope."
        },
        {
          "info": {
            "name": "List Report Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/reports/templates",
            "params": [
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "List report templates. Report templates are available for use with the Partner Reports API.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` [scopes](/docs/integrations#scopes). The authenticated user must be a Partner full administrator or Partner read-only administrator of the organization."
        }
      ]
    }
  ],
  "bundled": true
}