curl --request GET \
--url https://api.syntage.com/reports/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.syntage.com/reports/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.syntage.com/reports/{id}', 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://api.syntage.com/reports/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://api.syntage.com/reports/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntage.com/reports/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntage.com/reports/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"@context": "/contexts/InsightReport",
"@id": "/reports/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InsightReport",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"name": "Credit review",
"builtIn": false,
"organizational": false,
"insights": [
{
"name": "sales-revenue",
"type": "insight",
"insight": "sales-revenue",
"visible": true,
"children": "<array>",
"builtIn": true
}
],
"createdBy": {
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe"
},
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}{
"message": "<string>"
}{
"message": "<string>"
}Retrieve a report
Retrieve a report by ID. Use the report ID as the uri path segment when requesting a PDF download with the Exports API.
curl --request GET \
--url https://api.syntage.com/reports/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.syntage.com/reports/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.syntage.com/reports/{id}', 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://api.syntage.com/reports/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://api.syntage.com/reports/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntage.com/reports/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntage.com/reports/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"@context": "/contexts/InsightReport",
"@id": "/reports/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "InsightReport",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"name": "Credit review",
"builtIn": false,
"organizational": false,
"insights": [
{
"name": "sales-revenue",
"type": "insight",
"insight": "sales-revenue",
"visible": true,
"children": "<array>",
"builtIn": true
}
],
"createdBy": {
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe"
},
"createdAt": "2020-01-01T12:15:00.000Z",
"updatedAt": "2020-01-01T12:15:00.000Z"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Your API key is available in the Production and Sandbox dashboards.
Path Parameters
Response
Report resource response
Report IRI reference
"/reports/91106968-1abd-4d64-85c1-4e73d96fb997"
JSON-LD resource type
Unique report ID
"91106968-1abd-4d64-85c1-4e73d96fb997"
Report name shown in the dashboard's report selector; built-in reports use stable names such as full_report
"Credit review"
Whether the report is managed by Syntage; built-in reports are kept up to date automatically and cannot be modified or deleted
false
Whether the report is shared with every user in the organization; personal reports are only visible to their owner
false
Ordered layout of insight entries and groups rendered by the report
Show child attributes
Show child attributes
Profile of the user who created the report; omitted for built-in reports
Show child attributes
Show child attributes
Date and time the resource was created
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
"2020-01-01T12:15:00.000Z"
Was this page helpful?