API Reference

Report Subscriptions

5 endpoints· Auth: JWT or API Key
get/api/v1/console/report-subscriptions JWT API Key

Get report-subscriptions

Query parameters

Active
boolean
—
ReportKey
string
—
Page
integer (int32)
—
PerPage
integer (int32)
—
Search
string
—
Skip
integer (int32)
—
Sort
string
—
Dir
string
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/report-subscriptions" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/console/report-subscriptions JWT API Key

Create report-subscriptions

Request body

application/json
{
  "reportKey": "string",
  "recipientEmail": "string",
  "cadence": "Daily",
  "format": "Xlsx"
}
reportKey
string
—
recipientEmail
string
—
cadence
ReportCadence
—
format
ExportFormat
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/report-subscriptions" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "reportKey": "string",
  "recipientEmail": "string",
  "cadence": "Daily",
  "format": "Xlsx"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/console/report-subscriptions/{id} JWT API Key

Delete id

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "reason": "string"
}
reason
string
—

Responses

200Success
cURL
curl -X DELETE "https://staging-api.panoptesos.com/api/v1/console/report-subscriptions/{id}" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/console/report-subscriptions/{id}/activate JWT API Key

Create activate

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/report-subscriptions/{id}/activate" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/console/report-subscriptions/{id}/deactivate JWT API Key

Create deactivate

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/report-subscriptions/{id}/deactivate" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu