DynVoltDYNVOLT · developers

Reports

Reports endpoints of the DynVolt Open API.

Report overview, template catalog, generated runs, and scheduled subscriptions (create / update / delete / run-now).

GET /v1/sites/{site_id}/reports/overview

Reports overview.

Scope: reports:read · Module: basic_scada

curl "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/overview" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY"

GET /v1/sites/{site_id}/reports/catalog

Report template catalog.

Scope: reports:read · Module: basic_scada

curl "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/catalog" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY"

GET /v1/sites/{site_id}/reports/runs

Generated report runs (?limit).

Scope: reports:read · Module: basic_scada

Query parameterTypeRequiredDescription
limitintegernoMaximum rows to return (capped at 100).
curl "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/runs" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY"

GET /v1/sites/{site_id}/reports/subscriptions

Scheduled report subscriptions.

Scope: reports:read · Module: basic_scada

curl "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/subscriptions" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY"

POST /v1/sites/{site_id}/reports/subscriptions

Create a report subscription.

Scope: reports:write · Module: basic_scada · Write (rate-limited at 30/min)

  • Supports the Idempotency-Key header for safe retries (24-hour replay). Returns 409 conflict_safe_mode while the site is in commissioning safe mode.
curl -X POST "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/subscriptions" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{ ... }'

DELETE /v1/sites/{site_id}/reports/subscriptions/{sub_id}

Delete a report subscription.

Scope: reports:write · Module: basic_scada · Write (rate-limited at 30/min)

  • Supports the Idempotency-Key header for safe retries (24-hour replay). Returns 409 conflict_safe_mode while the site is in commissioning safe mode.
curl -X DELETE "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/subscriptions/5" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

PATCH /v1/sites/{site_id}/reports/subscriptions/{sub_id}

Update a report subscription.

Scope: reports:write · Module: basic_scada · Write (rate-limited at 30/min)

  • Supports the Idempotency-Key header for safe retries (24-hour replay). Returns 409 conflict_safe_mode while the site is in commissioning safe mode.
curl -X PATCH "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/subscriptions/5" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{ ... }'

POST /v1/sites/{site_id}/reports/subscriptions/{sub_id}/run

Run a report subscription now.

Scope: reports:write · Module: basic_scada · Write (rate-limited at 30/min)

  • Supports the Idempotency-Key header for safe retries (24-hour replay). Returns 409 conflict_safe_mode while the site is in commissioning safe mode.
curl -X POST "https://api.owner.dynvolt.com/v1/sites/pv-ljubas/reports/subscriptions/5/run" \
  -H "Authorization: Bearer $DYNVOLT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{ ... }'