---
title: "Create Disputes Report"
method: POST
path: "/reports/disputeHistoryEvents"
tags: ["Dispute Reports"]
---

# Create Disputes Report

`POST /reports/disputeHistoryEvents`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/reports/disputeHistoryEvents`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/reports/disputeHistoryEvents/post.ts> (a function with typed inputs; its response is checked against the schema)

Schedules the creation of a Dispute History Events Report.

Requires the `reports:CreateDisputeHistoryEvents` permission.

Please check our detailed guide on the report content and other considerations [here](https://docs.silverflow.com/guides/disputes-report).

## Request body

- DisputeHistoryEventsReportRequest: Create Disputes History Events Report
  - `parameters` DisputeHistoryEventsReportParameters, required: The query parameters used for a report.
    - `createdFrom` union, required: Include items that have a created date greater than or equal to the specified date/date-time. Accepts both date (YYYY-MM-DD) and ISO 8601 datetime formats. Use date format for queries before 2026-04-01T00:00:00Z. `date` type support is deprecated (April 1st, 2026).
      - string, date
      - string, date-time
    - `createdTo` union, required: Include items that have a created date less than or equal to the specified date/date-time. Accepts both date (YYYY-MM-DD) and ISO 8601 datetime formats. Use date format for queries before 2026-04-01T00:00:00Z. `date` type support is deprecated (April 1st, 2026).
      - string, date
      - string, date-time
  - `mimeType` 'text/csv' | 'application/json' | 'application/x-ndjson', required: The mime-type in which the disputes report is available.
  - `reference` string: Unique ID used to identify a report.
  - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Response `201`

The scheduled Disputes Report

- CreateDisputeHistoryEventsReportResponse
  - `reportName` 'DisputeHistoryEvents', required: The name of the report.
  - `parameters` DisputeHistoryEventsReportParameters, required: The query parameters used for a report.
    - `createdFrom` union, required: Include items that have a created date greater than or equal to the specified date/date-time. Accepts both date (YYYY-MM-DD) and ISO 8601 datetime formats. Use date format for queries before 2026-04-01T00:00:00Z. `date` type support is deprecated (April 1st, 2026).
      - string, date
      - string, date-time
    - `createdTo` union, required: Include items that have a created date less than or equal to the specified date/date-time. Accepts both date (YYYY-MM-DD) and ISO 8601 datetime formats. Use date format for queries before 2026-04-01T00:00:00Z. `date` type support is deprecated (April 1st, 2026).
      - string, date
      - string, date-time
  - `mimeType` 'text/csv' | 'application/json' | 'application/x-ndjson', required: The mime-type in which the disputes report is available.
  - `key` string, required: Uniquely identifies a report object
  - `agentKey` string, required: Uniquely identifies an Agent
  - `reference` string: Unique ID used to identify a report.
  - `status` 'scheduled', required: The status of the report.
  - `created` string, date-time, required: The date and time this object was created
  - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: Bin not found
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)