Create a report

POST

/v1/projects/{projectId}/collection-orders/{orderId}/reports

curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/reports' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "periodStart": "2026-01-01T00:00:00Z",
    "periodEnd": "2026-01-01T00:00:00Z",
    "grouping": "collector"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
orderIdstringrequired

Header parameters

Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

Content-Typeapplication/json

periodStartstring (date-time)required
periodEndstring (date-time)required
groupingstringrequired
Allowed values
collector
task
scene

Responses

Success

dataobjectrequired
- reportIdstringrequired
- orderIdstringrequired
- objectKeystringrequired
- downloadUrlstringrequired
- expiresAtstringrequired
- groupingstringrequired
  Allowed values
  task
  collector
  scene
- periodStartstringrequired
- periodEndstringrequired

Response example

{
  "data": {
    "reportId": "string",
    "orderId": "string",
    "objectKey": "string",
    "downloadUrl": "string",
    "expiresAt": "string",
    "grouping": "task",
    "periodStart": "string",
    "periodEnd": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1