Relativity

Relativity BillingInsights API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-billinginsights-api-openapi.yml

Other Resources

🔗
Plans
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/plans/relativity-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/finops/relativity-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/graphql/relativity-graphql.md

OpenAPI Specification

relativity-billinginsights-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService BillingInsights API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: BillingInsights
paths:
  /api/v1/billing-insights/hierarchy-lookup/{level}:
    get:
      tags:
      - BillingInsights
      summary: Get artifact ids
      description: Get artifact ids for workspace, matter, client, instance that can be used for filtering billing users and month details data.
      parameters:
      - name: level
        in: path
        description: The hierarchy level
        required: true
        schema:
          enum:
          - Workspace
          - Matter
          - Client
          - Instance
          - Contract
          type: string
      - name: instanceId
        in: query
        description: The instance ID
        schema:
          type: string
      - name: shouldUnhashData
        in: query
        description: Specifies if the response should include unhashed data. Default value is false.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetHierarchyLookupResponse'
              example:
                results:
                - name: Workspace A
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1001
                - name: Workspace B
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1002
                - name: Workspace C
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1003
                - name: Workspace D
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1004
                - name: Workspace A
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1001
                - name: Workspace B
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1002
                - name: Workspace X
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1003
                - name: Workspace Y
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 2005
            application/json:
              schema:
                $ref: '#/components/schemas/GetHierarchyLookupResponse'
              example:
                results:
                - name: Workspace A
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1001
                - name: Workspace B
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1002
                - name: Workspace C
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1003
                - name: Workspace D
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1004
                - name: Workspace A
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1001
                - name: Workspace B
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1002
                - name: Workspace X
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1003
                - name: Workspace Y
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 2005
            text/json:
              schema:
                $ref: '#/components/schemas/GetHierarchyLookupResponse'
              example:
                results:
                - name: Workspace A
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1001
                - name: Workspace B
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1002
                - name: Workspace C
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1003
                - name: Workspace D
                  selector:
                    instanceID: a2c4e2da-8596-4196-a704-9cd202ce6d47
                    workspaceArtifactID: 1004
                - name: Workspace A
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1001
                - name: Workspace B
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1002
                - name: Workspace X
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 1003
                - name: Workspace Y
                  selector:
                    instanceID: 891b6552-6db5-459b-a983-1ed94225da52
                    workspaceArtifactID: 2005
  /api/v1/billing-insights/month-details:
    post:
      tags:
      - BillingInsights
      summary: Get monthly billing metrics
      description: Get monthly billing metrics at the specific level (Workspace, Matter, Client, Instance) for a given date. If the requested data does not exist then an empty list will be returned (e.g. instance didn't exist in a given month)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMonthDetailsRequest'
            examples:
              All workspaces for an instance:
                summary: Metrics for all workspaces in the instance for a given date
                value:
                  dateKey: '202105'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Workspace
                  shouldUnhashData: false
              Single workspace for an instance:
                summary: Metrics for single workspace
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Workspace
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                    workspaceArtifactID: 2354352
                  level: Workspace
                  shouldUnhashData: false
              Top 10 results:
                summary: Paging
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Client
                  pagingRequest:
                    top: 10
                    skip: 0
                    includeCount: true
                  shouldUnhashData: false
              Order by:
                summary: Order by field (not applicable for if field was unhashed)
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Matter
                  order:
                    fieldName: PricedMetrics.Relativity_Storage_Review.BillableValue
                    direction: Desc
                  shouldUnhashData: false
          text/json:
            schema:
              $ref: '#/components/schemas/GetMonthDetailsRequest'
            examples:
              All workspaces for an instance:
                summary: Metrics for all workspaces in the instance for a given date
                value:
                  dateKey: '202105'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Workspace
                  shouldUnhashData: false
              Single workspace for an instance:
                summary: Metrics for single workspace
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Workspace
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                    workspaceArtifactID: 2354352
                  level: Workspace
                  shouldUnhashData: false
              Top 10 results:
                summary: Paging
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Client
                  pagingRequest:
                    top: 10
                    skip: 0
                    includeCount: true
                  shouldUnhashData: false
              Order by:
                summary: Order by field (not applicable for if field was unhashed)
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Matter
                  order:
                    fieldName: PricedMetrics.Relativity_Storage_Review.BillableValue
                    direction: Desc
                  shouldUnhashData: false
          application/*+json:
            schema:
              $ref: '#/components/schemas/GetMonthDetailsRequest'
            examples:
              All workspaces for an instance:
                summary: Metrics for all workspaces in the instance for a given date
                value:
                  dateKey: '202105'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Workspace
                  shouldUnhashData: false
              Single workspace for an instance:
                summary: Metrics for single workspace
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Workspace
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                    workspaceArtifactID: 2354352
                  level: Workspace
                  shouldUnhashData: false
              Top 10 results:
                summary: Paging
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Client
                  pagingRequest:
                    top: 10
                    skip: 0
                    includeCount: true
                  shouldUnhashData: false
              Order by:
                summary: Order by field (not applicable for if field was unhashed)
                value:
                  dateKey: '202106'
                  metricKeys:
                  - Relativity_Storage_Review
                  - Relativity_Storage_Repository
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  level: Matter
                  order:
                    fieldName: PricedMetrics.Relativity_Storage_Review.BillableValue
                    direction: Desc
                  shouldUnhashData: false
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetMonthDetailsResponse'
              example:
                results:
                - contract:
                    id: 10060000003IO9HXXX
                    name: Sample contract
                  instance:
                    id: f53c069b-9706-4570-8f97-be6e8fdbe156
                    name: R1 - Sample
                    pricingVisibility: Visible
                  client:
                    artifactID: 4001
                    name: Client 1
                    number: '1234'
                  matter:
                    artifactID: 3001
                    name: Matter 1
                    number: '1234'
                  workspace:
                    id: a2858a40-c24e-42d3-a6c1-28004f8b4c6f
                    artifactID: 2001
                    name: Sample workspace 1
                    activityStatus: Active
                    billableStatus: Billable
                  usageMetrics:
                    Relativity_Storage_Review:
                      reportedValue: 1000
                      collectionTimeUtc: '2021-09-10T14:12:00'
                      subMetrics:
                        Relativity_Storage_Linked:
                          value: 1000
                    Relativity_Storage_Repository:
                      reportedValue: 100
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetrics:
                    Relativity_Storage_Review:
                      billableValue: 1000
                      amount:
                        value: 100000
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                      subMetrics:
                        Relativity_Storage_Linked:
                          value: 1000
                    Relativity_Storage_Repository:
                      billableValue: 100
                      amount:
                        value: 2500
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 4000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 1000
                      comment: ''
                  usageMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 4000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 1000
                      comment: ''
                - contract:
                    id: 10060000003IO9HXXX
                    name: Sample contract
                  instance:
                    id: f53c069b-9706-4570-8f97-be6e8fdbe156
                    name: R1 - Sample
                    pricingVisibility: Visible
                  client:
                    artifactID: 8001
                    name: Client 2
                    number: '1234'
                  matter:
                    artifactID: 7001
                    name: Matter 2
                    number: '1234'
                  workspace:
                    id: 87f653b8-eb1f-4281-a6d8-17f8632123c6
                    artifactID: 6001
                    name: Sample workspace 2
                    activityStatus: Active
                    billableStatus: Billable
                  usageMetrics:
                    Relativity_Storage_Review:
                      reportedValue: 200
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetrics:
                    Relativity_Storage_Review:
                      billableValue: 200
                      amount:
                        value: 20000
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 8000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 0
                      comment: ''
                  usageMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 8000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 0
                      comment: ''
                pagingResponse:
                  totalRecordCount: 2
                status: OK
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonthDetailsResponse'
              example:
                results:
                - contract:
                    id: 10060000003IO9HXXX
                    name: Sample contract
                  instance:
                    id: f53c069b-9706-4570-8f97-be6e8fdbe156
                    name: R1 - Sample
                    pricingVisibility: Visible
                  client:
                    artifactID: 4001
                    name: Client 1
                    number: '1234'
                  matter:
                    artifactID: 3001
                    name: Matter 1
                    number: '1234'
                  workspace:
                    id: a2858a40-c24e-42d3-a6c1-28004f8b4c6f
                    artifactID: 2001
                    name: Sample workspace 1
                    activityStatus: Active
                    billableStatus: Billable
                  usageMetrics:
                    Relativity_Storage_Review:
                      reportedValue: 1000
                      collectionTimeUtc: '2021-09-10T14:12:00'
                      subMetrics:
                        Relativity_Storage_Linked:
                          value: 1000
                    Relativity_Storage_Repository:
                      reportedValue: 100
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetrics:
                    Relativity_Storage_Review:
                      billableValue: 1000
                      amount:
                        value: 100000
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                      subMetrics:
                        Relativity_Storage_Linked:
                          value: 1000
                    Relativity_Storage_Repository:
                      billableValue: 100
                      amount:
                        value: 2500
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 4000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 1000
                      comment: ''
                  usageMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 4000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 1000
                      comment: ''
                - contract:
                    id: 10060000003IO9HXXX
                    name: Sample contract
                  instance:
                    id: f53c069b-9706-4570-8f97-be6e8fdbe156
                    name: R1 - Sample
                    pricingVisibility: Visible
                  client:
                    artifactID: 8001
                    name: Client 2
                    number: '1234'
                  matter:
                    artifactID: 7001
                    name: Matter 2
                    number: '1234'
                  workspace:
                    id: 87f653b8-eb1f-4281-a6d8-17f8632123c6
                    artifactID: 6001
                    name: Sample workspace 2
                    activityStatus: Active
                    billableStatus: Billable
                  usageMetrics:
                    Relativity_Storage_Review:
                      reportedValue: 200
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetrics:
                    Relativity_Storage_Review:
                      billableValue: 200
                      amount:
                        value: 20000
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 8000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 0
                      comment: ''
                  usageMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 8000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 0
                      comment: ''
                pagingResponse:
                  totalRecordCount: 2
                status: OK
            text/json:
              schema:
                $ref: '#/components/schemas/GetMonthDetailsResponse'
              example:
                results:
                - contract:
                    id: 10060000003IO9HXXX
                    name: Sample contract
                  instance:
                    id: f53c069b-9706-4570-8f97-be6e8fdbe156
                    name: R1 - Sample
                    pricingVisibility: Visible
                  client:
                    artifactID: 4001
                    name: Client 1
                    number: '1234'
                  matter:
                    artifactID: 3001
                    name: Matter 1
                    number: '1234'
                  workspace:
                    id: a2858a40-c24e-42d3-a6c1-28004f8b4c6f
                    artifactID: 2001
                    name: Sample workspace 1
                    activityStatus: Active
                    billableStatus: Billable
                  usageMetrics:
                    Relativity_Storage_Review:
                      reportedValue: 1000
                      collectionTimeUtc: '2021-09-10T14:12:00'
                      subMetrics:
                        Relativity_Storage_Linked:
                          value: 1000
                    Relativity_Storage_Repository:
                      reportedValue: 100
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetrics:
                    Relativity_Storage_Review:
                      billableValue: 1000
                      amount:
                        value: 100000
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                      subMetrics:
                        Relativity_Storage_Linked:
                          value: 1000
                    Relativity_Storage_Repository:
                      billableValue: 100
                      amount:
                        value: 2500
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 4000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 1000
                      comment: ''
                  usageMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 4000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 1000
                      comment: ''
                - contract:
                    id: 10060000003IO9HXXX
                    name: Sample contract
                  instance:
                    id: f53c069b-9706-4570-8f97-be6e8fdbe156
                    name: R1 - Sample
                    pricingVisibility: Visible
                  client:
                    artifactID: 8001
                    name: Client 2
                    number: '1234'
                  matter:
                    artifactID: 7001
                    name: Matter 2
                    number: '1234'
                  workspace:
                    id: 87f653b8-eb1f-4281-a6d8-17f8632123c6
                    artifactID: 6001
                    name: Sample workspace 2
                    activityStatus: Active
                    billableStatus: Billable
                  usageMetrics:
                    Relativity_Storage_Review:
                      reportedValue: 200
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetrics:
                    Relativity_Storage_Review:
                      billableValue: 200
                      amount:
                        value: 20000
                        currency: USD
                      collectionTimeUtc: '2021-09-10T14:12:00'
                  pricedMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 8000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 0
                      comment: ''
                  usageMetricsSubMetricsSummary:
                    Relativity_Storage_TextOnlyDocuments:
                      value: 8000
                      comment: ''
                    Relativity_Storage_Linked:
                      value: 0
                      comment: ''
                pagingResponse:
                  totalRecordCount: 2
                status: OK
  /api/v1/billing-insights/users-details:
    post:
      tags:
      - BillingInsights
      summary: Get a user list
      description: Get a user list with billing attributes for a given date
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUsersDetailsRequest'
            examples:
              All users:
                summary: Get all users for a given instance and date
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              Filter by:
                summary: Filtering
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  filters:
                  - fieldName: BillableStatus
                    operator: '='
                    value: Billable RelativityOne
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              Order by email:
                summary: Order by
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  order:
                    fieldName: Email
                    direction: Desc
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              Workspace users:
                summary: Users with access to a workspace
                value:
                  dateKey: '202105'
                  selectorLevel: Workspace
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                    workspaceArtifactID: 2315123
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              All users with workspace artifactId info:
                summary: Get all users for a given instance and date with list of workspace artifactIds to which user has access to
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  includeWorkspaceInfo: true
                  shouldUnhashData: false
          text/json:
            schema:
              $ref: '#/components/schemas/GetUsersDetailsRequest'
            examples:
              All users:
                summary: Get all users for a given instance and date
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              Filter by:
                summary: Filtering
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  filters:
                  - fieldName: BillableStatus
                    operator: '='
                    value: Billable RelativityOne
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              Order by email:
                summary: Order by
                value:
                  dateKey: '202105'
                  selectorLevel: Instance
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                  order:
                    fieldName: Email
                    direction: Desc
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              Workspace users:
                summary: Users with access to a workspace
                value:
                  dateKey: '202105'
                  selectorLevel: Workspace
                  itemSelectors:
                  - instanceID: f53c069b-9706-4570-8f97-be6e8fdbe156
                    workspaceArtifactID: 2315123
                  includeWorkspaceInfo: false
                  shouldUnhashData: false
              All users with workspace artifactId info:
                summary: Get all users for a given instance and date with list of workspace artifactIds to which user has access to
                value:
                  dateKey: '202105'
             

# --- truncated at 32 KB (107 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-billinginsights-api-openapi.yml