Analytics report

A period's analytics as the Analytics page PDF, or every measure as CSV or Excel.

PriceFree
Typical time5 s to 2 min
Scopereports:read
Runs asA background job

Try it

Run analytics report in the sandbox

No key and nothing to pay. The sandbox returns a realistic example in a couple of seconds; no AI runs and no data is kept.

Queued202 and a job id, straight away
ProcessingPoll, stream or wait for a webhook
SucceededResult and files on the job

Every AI request runs as a background job, so nothing times out.

PDF: the Analytics page report (marking turnaround, throughput, first-time pass rate, AI agreement). CSV or Excel: one row per measure, with the period before and exactly what each counts. Uses the key creator's analytics access. Free. Download the file from GET /jobs/{job_id}/files/analytics.pdf (or .csv / .xlsx).

Requires reports:read. Free. Send a unique Idempotency-Key; reuse it with the identical body when retrying. Returns 202 with a job: poll GET /jobs/{job_id}, stream GET /jobs/{job_id}/events, or use a signed webhook.

Analytics report

POST/v1/reports/analytics

Scope reports:read

Headers

Analytics report: headers
Field	Details
`Idempotency-Key`	stringRequiredA unique key per new operation; reuse it with the identical body when retrying.
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Request body

Analytics report: request body
Field	Details
`start_date`	string (date)Required
`end_date`	string (date)Required
`format`	enumpdf: the Analytics page report. csv or xlsx: one row per measure.One of `xlsx`, `csv`, `pdf`Default `"pdf"`
`title`	stringPDF title.Up to 160 charactersDefault `"Analytics report"`
`parts`	array of enumPDF sections: marking turnaround, throughput, first-time pass rate, AI agreement.1 to 4 items
`metrics`	array of string, optionalCSV/Excel: measures from GET /v1/analytics/metrics. Default: a progress and marking set.1 to 30 items
`course_id`	string, optionalUp to 200 charactersPattern `^[A-Za-z0-9][A-Za-z0-9._:-]{0,199}$`
`cohort`	string, optionalUp to 200 charactersPattern `^[A-Za-z0-9][A-Za-z0-9._:-]{0,199}$`

Responses

Status	Meaning
202	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
402	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl -X POST 'https://api.edumark.ai/v1/reports/analytics' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "start_date": "2026-09-01",
  "end_date": "2026-09-30",
  "format": "xlsx"
}'

# Then poll until the job finishes (wait poll_after_seconds between calls)
curl 'https://api.edumark.ai/v1/jobs/job_01JB7Q8M4X2V9R' \
  -H "Authorization: Bearer $EDUMARK_API_KEY"

Queued202 and a job id, straight away
ProcessingPoll, stream or wait for a webhook
SucceededResult and files on the job

Every AI request runs as a background job, so nothing times out.

Response 202JSON

{
  "id": "job_0123456789abcdef0123456789abcdef01234567",
  "product": "reports_analytics",
  "status": "queued",
  "poll_after_seconds": 2,
  "credits": 0,
  "result_available": false
}

Finished job: resultJSON

{
  "report": "analytics",
  "format": "xlsx",
  "start_date": "2026-09-01",
  "end_date": "2026-09-30",
  "measures": 9,
  "file": {
    "name": "analytics.xlsx",
    "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    "size_bytes": 9120
  },
  "note": null
}