Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Relativity Reports API

The Reports API from Relativity — 7 operation(s) for reports.

Relativity Reports API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 11 operations across 7 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

11 operations 7 paths 15 schemas 2 DELETE7 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 2 DELETE, 7 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 11
POST
/v4/Reports
Create new report
body → 200400401403429
GET
/v4/Reports
Get reports list
4 params → 200400401403
GET
/v4/Reports/{id}
Get report details
1 param → 200400401403
DELETE
/v4/Reports/{id}
Cancel report
1 param → 200400401404
GET
/v4/Reports/{id}/file
Download report file
1 param → 200400401
GET
/v1/Reports/{id}
Gets the details of a report by ID
1 param → 200400401404
DELETE
/v1/Reports/{id}
Delete a report by ID
1 param → 200400401404
GET
/v1/Reports/{id}/details
Gets the detailed information of a report by ID
3 params → 200204400401404503
GET
/v1/Reports
Lists all reports
→ 200400401404
POST
/v1/Reports
Generate a new report
body → 200400401
GET
/v1/Reports/download/{id}
Download a report by ID
1 param → 200400401404503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ReportJobResponse (12 properties), ReportDto (10 properties), Stream (8 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

CreateReportRequestDto
object
4 properties
DateRangeDto
object
2 properties
ReportDepth
string
ReportDto
object
10 properties
ProblemDetails
object
5 properties
ReportJobResponse
object
12 properties
ReportDetailsDto
object
5 properties
DirectoryReportRequest
object
5 properties 2 required
ReportCategory
string
ReportsDto
object
1 property
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
ReportResponse
object
1 property
Page
object
2 properties 2 required
Stream
object
8 properties
ReportJobsResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-reports-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API