Relativity

Relativity Metrics Module API

The Metrics Module API from Relativity — 8 operation(s) for metrics module.

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-metrics-module-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-metrics-module-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Metrics Module API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Metrics Module
paths:
  /LogCountAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IAPMManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IAPMManager.LogCountAsync
      parameters:
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogCountAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /LogTimerAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IAPMManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IAPMManager.LogTimerAsync
      parameters:
      - $ref: '#/components/parameters/milliseconds'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogTimerAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /LogTimerAsLongAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IMetricsManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IMetricsManager.LogTimerAsLongAsync
      parameters:
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/workspaceGuid'
      - $ref: '#/components/parameters/milliseconds'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /LogTimerAsDoubleAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IMetricsManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IMetricsManager.LogTimerAsDoubleAsync
      parameters:
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/workspaceGuid'
      - $ref: '#/components/parameters/milliseconds'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /LogPointInTimeStringAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IMetricsManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IMetricsManager.LogPointInTimeStringAsync
      parameters:
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/workspaceGuid'
      - $ref: '#/components/parameters/value'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /LogPointInTimeLongAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IMetricsManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IMetricsManager.LogPointInTimeLongAsync
      parameters:
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/workspaceGuid'
      - $ref: '#/components/parameters/value'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /LogPointInTimeDoubleAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IMetricsManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IMetricsManager.LogPointInTimeDoubleAsync
      parameters:
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/workspaceGuid'
      - $ref: '#/components/parameters/value'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /LogMetricsAsync:
    post:
      tags:
      - Metrics Module
      description: '[Private] IMetricsManager - '
      operationId: Relativity.Telemetry.Services.Metrics.IMetricsManager.LogMetricsAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogMetricsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
components:
  schemas:
    LogMetricsAsync_RequestBody:
      title: LogMetricsAsync_RequestBody
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricRef'
    Object:
      title: Object
      type: object
    LogCountAsync_RequestBody:
      title: LogCountAsync_RequestBody
      type: object
      properties:
        metric:
          $ref: '#/components/schemas/APMMetric'
    APMMetric:
      title: APMMetric
      type: object
      properties:
        Name:
          type: string
        CustomData:
          type: object
          additionalProperties:
            title: Object
            type: object
    MetricRef:
      title: MetricRef
      type: object
      properties:
        Bucket:
          type: string
        WorkspaceGuid:
          type: string
          nullable: true
        ClientDomainGuid:
          type: string
          nullable: true
        WorkflowID:
          type: string
        MetricTarget:
          enum:
          - APM
          - SUM
          - APMandSUM
          type: string
        MetricType:
          enum:
          - Counter
          - Gauge
          - Timer
          - PointInTimeLong
          - PointInTimeString
          - PointInTimeDouble
          type: string
        Value:
          $ref: '#/components/schemas/Object'
    LogTimerAsync_RequestBody:
      title: LogTimerAsync_RequestBody
      type: object
      properties:
        metric:
          $ref: '#/components/schemas/APMMetric'
  parameters:
    bucket:
      name: bucket
      in: query
      description: ''
      required: true
      schema:
        type: string
    value:
      name: value
      in: query
      description: ''
      required: true
      schema:
        type: string
    workspaceGuid:
      name: workspaceGuid
      in: query
      description: ''
      required: true
      schema:
        type: string
    count:
      name: count
      in: query
      description: ''
      required: true
      schema:
        type: integer
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'
    milliseconds:
      name: milliseconds
      in: query
      description: ''
      required: true
      schema:
        type: number