Skip to main content
GET
/
sites
/
v2
/
rs
/
synthesis
/
{siteId}
Get the site synthesis
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/sites/v2/rs/synthesis/{siteId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "filename": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
siteId
integer
required

Unique identifier of the site.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Query Parameters

​
startDate
string

Start date

​
endDate
string

End date

​
includeIdentity
boolean

Include identity

​
includeCommissions
boolean

Include commissions

​
includeVerificationIT
boolean

Include Verification IT

​
includeCorrectionIT
boolean

Include Correction IT

​
includeReports
boolean

Include Reports

​
includeAnomalies
boolean

Include Anomalies

​
includePrescriptions
boolean

Include Prescriptions

​
interactiveDate
string

Interactive date

​
period
string

Period

​
dataType
string

Data type

​
version
string

API version

​
synthesis
enum<string>

Filter rules by compliance type

Available options:
register,
maintenance
​
timezone
string

IANA timezone for formatting dates (e.g. Europe/Paris)

Response

200 - application/json

PDF file uploaded to S3 with presigned URL

​
filename
string
required

Name of the generated PDF file

​
url
string<uri>
required

Presigned URL to download the PDF (valid for 1 hour)