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 BillingInsights API

The BillingInsights API from Relativity — 6 operation(s) for billinginsights.

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

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

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

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

6 operations 6 paths 26 schemas 2 GET4 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 6

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

BillingInsights 6
GET
/api/v1/billing-insights/hierarchy-lookup/{level}
Get artifact ids
3 params → 200
POST
/api/v1/billing-insights/month-details
Get monthly billing metrics
body → 200
POST
/api/v1/billing-insights/users-details
Get a user list
body → 200
GET
/api/v2/billing-insights/hierarchy-lookup/{level}
Get artifact ids
3 params → 200
POST
/api/v2/billing-insights/month-details
Get monthly billing metrics
body → 200
POST
/api/v2/billing-insights/users-details
Get a user list
body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are GetUsersDetailsResponseItem (12 properties), Workspace_2 (11 properties), Workspace (10 properties), GetMonthDetailsRequest (10 properties). Each schema is shown below with its type and property counts.

FieldFilter
object
Field filter information
3 properties
Contract
object
Contract information
2 properties
GetMonthDetailsResponse
object
3 properties
HierarchyItemSelector
object
Specifies item to select. instanceID must be provided, additionally depending on the chosen level must be provided clientArtifactID, matterArtifactID or worksp…
5 properties
SingleUsageMetric
object
5 properties
Money
object
2 properties
Workspace
object
Workspace information
10 properties
GetUsersDetailsResponse
object
2 properties
Client
object
Client information.
6 properties
Matter
object
Matter information
5 properties
Instance
object
Instance information
3 properties
GetMonthDetailsRequest
object
Request body used in month-details API
10 properties
PagingResponse
object
Paging information about the response. If the caller wants to obtain the rest of the result set there should be subsequent request made with same parameters an…
2 properties
PagingRequest
object
Specifies paging options - top and skip values need to be either empty or populated. Specifying just a single value is considered a bad request. - if top and s…
5 properties
FieldOrder
object
Allows to specify order that should be applied to the query result
2 properties
GetMonthDetailsResponseItem
object
9 properties
GetUsersDetailsResponseItem
object
12 properties
SingleSubMetric
object
2 properties
ClientMatterData
object
2 properties
GetUsersDetailsRequest
object
Request body used in users-details API
8 properties
GetHierarchyLookupResponse
object
1 property
MetricMetadata
object
3 properties
GetHierarchyLookupResponseItem
object
4 properties
UserInstanceSpecificData
object
4 properties
SinglePricedMetric
object
7 properties
Workspace_2
object
Workspace information
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-billinginsights-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 Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API
Relativity Document Configuration Module API