Get a report

Retrieve a single report by GUID or ObjectId.

GET /reports/{id}

Get a report

cURL

curl --request GET \
  --url 'https://www.thereviewport.com/api/reports/{id}?apiKey='

200

{
  "guid": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "preview": {},
  "publishedDate": "2023-11-07T05:31:56Z",
  "region": "<string>",
  "issueType": "<string>",
  "issueVersion": "<string>",
  "isFeatured": true,
  "images": {
    "header": "<string>",
    "thumbnail": "<string>"
  },
  "manager": {
    "id": "<string>",
    "guid": "<string>",
    "name": "<string>",
    "logo": "<string>"
  },
  "issuer": {
    "id": "<string>",
    "guid": "<string>",
    "name": "<string>",
    "logo": "<string>"
  },
  "retentionHolder": {},
  "tags": [
    {
      "id": "<string>",
      "label": "<string>",
      "slug": "<string>"
    }
  ],
  "sourceDoc": {},
  "content": {
    "highlights": "<string>",
    "keyConsiderations": "<string>",
    "firstLook": "<string>",
    "body": "<string>"
  },
  "links": {
    "self": "<string>",
    "web": "<string>",
    "embed": "<string>"
  }
}

Authorizations

ApiKeyQueryApiKeyHeader

apiKey · string · query · required

API key passed as query parameter

Path Parameters

id · string · required

Report GUID or ObjectId

Query Parameters

includeBody · boolean · default: false

Include full body content

Response

200

application/json

Successful response

guid · string

title · string

summary · string | null

preview · object

publishedDate · string<date-time>

region · string | null

issueType · string | null

issueVersion · string | null

isFeatured · boolean

images · object

Show child attributes

manager · object

Show child attributes

issuer · object

Show child attributes

retentionHolder · object

tags · object[]

Show child attributes

sourceDoc · object

content · object

Show child attributes

links · object

Show child attributes