Syntage Reports API
Reports group entity insights into a configurable layout. A report is rendered in the dashboard's Reports section and can be downloaded as a PDF document with the [Exports API](/api-reference/exports/export-data).Built-in reports are created and kept up to date by Syntage and cannot be modified or deleted. Custom reports are personal by default; organizational reports are shared with every user in the organization.
Syntage Reports API is one of 65 APIs that Syntage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes 5 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2020-06-28.
Requests are made against 2 base URLs: https://api.syntage.com, https://api.sandbox.syntage.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Syntage Reports API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (ApiKey).
By default, every request must be authenticated.
ApiKey— Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashb…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Reports group entity insights into a configurable layout. A report is rendered in the dashboard's Reports section and can be downloaded as a PDF document with the [Exports API](/a…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are InsightReport (10 properties), InsightReportInsightEntry (6 properties), HydraView (6 properties), InsightReportInsightEntryInput (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Syntage 12
Other APIs Syntage publishes across the network.
This is an independent, third-party profile of Syntage Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.