v1
latestOpenAPI 3.0.02026-08-062903562.2 MBAnnual Summary
Organization
Get Organization ASR Batch for Year
Get the ASR batch for an organization for a specific year. Returns the single batch or 404 if none exists.
get/organizations/{organization_id}/annual-summary-reports/{year}
Path parameters
organization_idinteger required
Example:1
The specified Organization ID
yearinteger required
Example:2024
The report year
Query parameters
status'pending' | 'processing' | 'generating' | 'completed' | 'failed'
Example:completed
Filter by batch status
limitinteger
Example:10
Number of results per page
Response
Batch information
Example response
{
"organization_id": 1,
"report_year": 2024,
"status": "completed",
"total_count": 1000,
"completed_count": 1000,
"progress_percentage": 100,
"is_complete": true,
"started_at": "2024-10-06T12:00:00+00:00",
"completed_at": "2024-10-06T12:30:00+00:00",
"scheduled_at": "2024-10-06T14:00:00+00:00",
"audience": {
"offline": true,
"one_time": true,
"recurring": true
},
"created_at": "2024-10-06T11:55:00+00:00",
"updated_at": "2024-10-06T12:30:00+00:00"
}