GET /reports/{reportId}

Gets a report based on the specified ID

Servers

Path parameters

Name Type Required Description
reportId Number Yes

reportID of the report being accessed.

Request headers

Name Type Required Description
Accept String No

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Query parameters

Name Type Required Description
include String No

A comma-separated list of optional elements to include in the response:

  • attachments
  • discussions
  • proofs
  • format
  • objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data
  • scope - adds the report's scope to the response
  • source - adds the Source object indicating which report the report was created from, if any
  • sourceSheets

Possible values:

  • "source"
  • "discussions"
  • "objectValue"
  • "attachments"
  • "scope"
  • "sourceSheets"
  • "proofs"
  • "format"
level Integer No

specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=3).

Default value: 0

accessApiLevel Number No

Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

Default value: 0

exclude String No

A comma-separated list of optional elements to not include in the response

Possible values:

  • "linkInFromCellDetails"
  • "linksOutToCellsDetails"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.