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

# Create Report

`POST /reports`

This endpoint retrieves a report owned by a 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 to be run. Allowed values: hit_miss_summary, browser_summary, os_summary, request_details_export, miss_details_export, health_check_export.
  - `domain_id` integer, required — The Domain ID the report will be associated with.
  - `parameters` object — Object of parameters specific to each report.
    - `date_start` string, date — Date to start pulling data from.
    - `date_end` string, date — Date to finish pulling data from.
    - `group_by` string — Date range to group data by. Supported values are day, month, week, year.
    - `link_ids` integer[] — Array of Link IDs to filter results by.

## Response `201`

201

- object
  - `id` integer
  - `name` string
  - `type` string
  - `parameters` object
    - `date_end` string
    - `date_start` string
  - `schedule` object
    - `run_at` string
    - `recurring` boolean
  - `domain_id` integer
  - `status` string

## Other responses

- `422` — 422

---

[API](https://skmtc.net/seebot/apis/seebotlink.md) · [All operations](https://skmtc.net/seebot/apis/seebotlink/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seebot/seebotlink/versions/2853c55f2fec/schema)