List reports

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

{
  "meta": {
    "page": 123,
    "pageSize": 123,
    "total": 123,
    "totalPages": 123,
    "hasNextPage": true
  },
  "results": [
    {
      "guid": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "publishedDate": "2023-11-07T05:31:56Z",
      "region": "<string>",
      "issueType": "<string>",
      "issueVersion": "<string>",
      "isFeatured": true,
      "images": {
        "header": "<string>",
        "thumbnail": "<string>"
      },
      "manager": {
        "guid": "<string>",
        "name": "<string>",
        "logo": "<string>"
      },
      "issuer": {
        "guid": "<string>",
        "name": "<string>",
        "logo": "<string>"
      },
      "tags": [
        {
          "id": "<string>",
          "label": "<string>",
          "slug": "<string>"
        }
      ],
      "links": {
        "self": "<string>",
        "web": "<string>",
        "embed": "<string>"
      }
    }
  ]
}

GET

reports

List reports

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

{
  "meta": {
    "page": 123,
    "pageSize": 123,
    "total": 123,
    "totalPages": 123,
    "hasNextPage": true
  },
  "results": [
    {
      "guid": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "publishedDate": "2023-11-07T05:31:56Z",
      "region": "<string>",
      "issueType": "<string>",
      "issueVersion": "<string>",
      "isFeatured": true,
      "images": {
        "header": "<string>",
        "thumbnail": "<string>"
      },
      "manager": {
        "guid": "<string>",
        "name": "<string>",
        "logo": "<string>"
      },
      "issuer": {
        "guid": "<string>",
        "name": "<string>",
        "logo": "<string>"
      },
      "tags": [
        {
          "id": "<string>",
          "label": "<string>",
          "slug": "<string>"
        }
      ],
      "links": {
        "self": "<string>",
        "web": "<string>",
        "embed": "<string>"
      }
    }
  ]
}

Authorizations

apiKey

string

query

required

API key passed as query parameter

Query Parameters

page

integer

default:1

Page number (1-indexed)

Required range: x >= 1

pageSize

integer

default:20

Number of items per page

Required range: 1 <= x <= 100

string

Text search query

region

string

Filter by region

issueType

string

Filter by issue type

issueVersion

string

Filter by issue version

tagSlug

string

Filter by tag slug

isFeatured

boolean

Filter by featured status

fromDate

string<date>

Filter by published date (from)

toDate

string<date>

Filter by published date (to)

manager

string

Filter by manager ObjectId

managerGuid

string

Filter by manager GUID

issuer

string

Filter by issuer ObjectId

issuerGuid

string

Filter by issuer GUID

Response

Successful response