Get a report

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

const options = {method: 'GET'};

fetch('https://www.thereviewport.com/api/reports/{id}?apiKey=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.thereviewport.com/api/reports/{id}?apiKey=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.thereviewport.com/api/reports/{id}?apiKey="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.thereviewport.com/api/reports/{id}?apiKey=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>"
  }
}

{
  "error": "API key required. Provide via query ?apiKey=... or header x-api-key."
}

{
  "error": "Access to reports is not permitted for this API key."
}

{
  "error": "Report not found"
}

{
  "error": "Rate limit exceeded. Try again later."
}

GET

reports

{id}

Get a report

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

const options = {method: 'GET'};

fetch('https://www.thereviewport.com/api/reports/{id}?apiKey=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.thereviewport.com/api/reports/{id}?apiKey=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.thereviewport.com/api/reports/{id}?apiKey="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.thereviewport.com/api/reports/{id}?apiKey=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>"
  }
}

{
  "error": "API key required. Provide via query ?apiKey=... or header x-api-key."
}

{
  "error": "Access to reports is not permitted for this API key."
}

{
  "error": "Report not found"
}

{
  "error": "Rate limit exceeded. Try again later."
}

Authorizations

apiKey

string

query

required

API key passed as query parameter

Path Parameters

string

required

Report GUID or ObjectId

Query Parameters

includeBody

boolean

default:false

Include full body content

Response

Successful response

guid

string

title

string

summary

string | null

preview

object | null

publishedDate

string<date-time>

region

string | null

issueType

string | null

issueVersion

string | null

isFeatured

boolean

images

object

Show child attributes

manager

object | null

Show child attributes

issuer

object | null

Show child attributes

retentionHolder

object | null

Introduction

Endpoints

Get a report

Authorizations

Path Parameters

Query Parameters

Response