---
title: "Create Report"
method: POST
path: "/reports"
---

# Create Report

`POST /reports`

This endpoint creates a new report and associates it with the client.

## Request body

- object
  - `name` string, required — The name used to easily identify the report. Allowed values are between 2 and 255 characters.
  - `type` string, required — The type of report. Allowed values are call_summary, rep_summary, call_export, segment_person_export.
  - `params` object, required — The report params used to defined the scope of the data being reported.
    - `date_start` string, date, required — The state of the date range being reported.
    - `date_end` string, date, required — The end of the date range being reported.
    - `group_by` string — The date range to group results by on each line. Allowed values are day, week, month, year. Required if type is set to call_summary or rep_summary.
    - `direction` string — The calls with set direction to return when provided. Allowed values are in and out. Only allowed when type is call_export. Default will include all calls.
    - `number_ids` integer[] — The numbers IDs of the numbers to filter on for the report. Only allowed when type is call_summary, rep_summary, call_export. Default will include all segments.
    - `segment_ids` integer[] — The segment IDs of the segments to filter for the report. Only allowed when type is segment_person_export. Default will include all segments.
    - `attribute_ids` integer[] — The attribute IDs of the attributes to include with each person. Only allowed when type is segment_person_export. Default will include all attributes available.

## Response `201`

201

- object
  - `id` integer
  - `name` string
  - `type` string
  - `params` object
    - `date_end` string
    - `group_by` string
    - `date_start` string
    - `number_ids` unknown[]
      - unknown
  - `schedule` object
    - `run_at` string
    - `recurring` boolean
  - `status` string

## Other responses

- `422` — 422

---

[API](https://skmtc.dev/seebot/apis/seebottalk.md) · [All operations](https://skmtc.dev/seebot/apis/seebottalk/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/seebot/seebottalk/revisions/4b8c104ade48/schema)