---
title: "create report"
method: POST
path: "/v{version}/reports"
tags: ["Report"]
---

# create report

`POST /v{version}/reports`

Queues a report generation and pings the caller back with a webhook once the report is complete.<p>Scopes: export_enrollment</p>

## Path parameters

- `version` string, required

## Request body

- DtosReport — The request to generate a report with a callback URL.
  - `callback_url` string, required — The URL that a notification will be sent to once the report is completed. The payload will contain the URL of the report for retrieval. Example payload: { "url": "https://secure.ease.com/v2/files?foo=bar", "status": "Success" }
  - `report` DtosReportRequest, required
    - `activity_census` DtosActivityCensusParameters
      - `from_date` string, required
      - `to_date` string, required
      - `report_type` 'Detailed' | 'Add' | 'Change' | 'Termination', required
      - `company_id` string, required
    - `enrollment_census` DtosEnrollmentCensusParameters
      - `layout` 'Vertical' | 'Horizontal', required
      - `view` 'Current' | 'EffectiveAsOf' | 'SystemAsOf', required
      - `include_dependents` boolean, required
      - `employee_statuses` string[], required
      - `employee_types` string[], required
      - `plan_ids` string[], required
      - `company_id` string, required
    - `full_census` DtosFullCensusParameters
      - `layout` 'Vertical' | 'Horizontal', required
      - `include_dependents` boolean, required
      - `employee_statuses` string[], required
      - `employee_types` string[], required
      - `eligibilities` string[], required
      - `company_id` string, required
    - `open_enrollment_changes` DtosOpenEnrollmentChangesParameters
      - `plan_ids` string[], required
      - `company_id` string, required
    - `enrollment_history` DtosEnrollmentHistoryParameters
      - `employee_id` string, required

## Response `200`

Success

---

[API](https://skmtc.net/ease/apis/version-2.md) · [All operations](https://skmtc.net/ease/apis/version-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ease/version-2/revisions/be66ed178abe/schema)