Chronosphere Dataset API

openapi: 3.2.0
info:
  title: Chronosphere Dataset API
  version: v1
  description: 'Operations tagged Dataset across 2 of this provider''s published API definitions: chronosphere-config-v1-openapi3.json, chronosphere-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}.chronosphere.io
  variables:
    tenant:
      default: tenant
      description: tenant ID assigned by the service provider
- url: /
tags:
- name: Dataset
paths:
  /api/v1/config/datasets:
    get:
      operationId: ListDatasets
      parameters:
      - description: 'Sets the preferred number of items to return per page. If set to `0`, the

          server will use its default value. Regardless of the value specified, clients

          must never assume how many items will be returned.'
        in: query
        name: page.max_size
        schema:
          format: int64
          type: integer
      - description: 'An opaque page token that identifies which page the client should request.

          An empty value indicates the first page.'
        in: query
        name: page.token
        schema:
          type: string
      - description: Filters results by slug, where any Dataset with a matching slug in the given list (and matches all other filters) will be returned.
        in: query
        name: slugs
        schema:
          items:
            type: string
          type: array
      - description: Filters results by name, where any Dataset with a matching name in the given list (and matches all other filters) will be returned.
        in: query
        name: names
        schema:
          items:
            type: string
          type: array
      - description: 'Custom filtering option: list filtered down to a specific telemetry type.'
        in: query
        name: type
        schema:
          enum:
          - TRACES
          - LOGS
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ListDatasetsResponse'
          description: A successful response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
      tags:
      - Dataset
      security:
      - ApiKeyAuth: []
      summary: List datasets
      x-summary-source: derived
    post:
      operationId: CreateDataset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configv1CreateDatasetRequest'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1CreateDatasetResponse'
          description: A successful response containing the created Dataset.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the Dataset because the request is invalid.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot create the Dataset because there is a conflict with an existing Dataset.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
      tags:
      - Dataset
      security:
      - ApiKeyAuth: []
      summary: Create dataset
      x-summary-source: derived
    servers:
    - url: https://{tenant}.chronosphere.io
      variables:
        tenant:
          default: tenant
          description: tenant ID assigned by the service provider
  /api/v1/config/datasets/{slug}:
    delete:
      operationId: DeleteDataset
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1DeleteDatasetResponse'
          description: A successful response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the Dataset because it is in use.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot delete the Dataset because the slug does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
      tags:
      - Dataset
      security:
      - ApiKeyAuth: []
      summary: Delete dataset
      x-summary-source: derived
    get:
      operationId: ReadDataset
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadDatasetResponse'
          description: A successful response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot read the Dataset because the slug does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
      tags:
      - Dataset
      security:
      - ApiKeyAuth: []
      summary: Read dataset
      x-summary-source: derived
    put:
      operationId: UpdateDataset
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigV1UpdateDatasetBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1UpdateDatasetResponse'
          description: A successful response containing the updated Dataset.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the Dataset because the request is invalid.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the Dataset because the slug does not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the Dataset because there is a conflict with an existing Dataset.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
      tags:
      - Dataset
      security:
      - ApiKeyAuth: []
      summary: Update dataset
      x-summary-source: derived
    servers:
    - url: https://{tenant}.chronosphere.io
      variables:
        tenant:
          default: tenant
          description: tenant ID assigned by the service provider
components:
  schemas:
    configv1CreateDatasetRequest:
      properties:
        dataset:
          allOf:
          - $ref: '#/components/schemas/configv1Dataset'
          description: The Dataset to create.
        dry_run:
          description: If `true`, validates the specified configuration without creating the Dataset. If the specified configuration is valid, the endpoint returns a partial response without the Dataset. If the specified configuration is invalid, the endpoint returns an error.
          type: boolean
      type: object
    configv1LogDataset:
      properties:
        match_criteria:
          allOf:
          - $ref: '#/components/schemas/configv1LogSearchFilter'
          description: Required. Defines the criteria to match logs to a dataset.
      type: object
    genericError:
      additionalProperties: true
      type: object
    configv1TraceSearchFilter:
      properties:
        scope_filter:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterScopeFilter'
          description: Scope filter that defines which spans within matching traces contribute to metrics calculation.
        span:
          description: 'Specifies the span conditions to match on. All conditions must be true in a

            single span for the span to be considered a match. If `span_count` is specified,

            the number of spans within the trace that match span conditions must be within

            `[min, max]`. You can specify multiple span conditions, and each can be

            satisfied by any number of spans within the trace.'
          items:
            $ref: '#/components/schemas/TraceSearchFilterSpanFilter'
          type: array
        trace:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterTraceFilter'
          description: Trace-level filter criteria (effectively matching the root span).
      type: object
    TraceSearchFilterNumericFilter:
      properties:
        comparison:
          allOf:
          - $ref: '#/components/schemas/NumericFilterComparisonType'
          description: The comparison operation to apply to an input against the given query value.
        value:
          description: The filter value used in comparison against match candidates.
          format: double
          type: number
      type: object
    configv1ReadDatasetResponse:
      properties:
        dataset:
          $ref: '#/components/schemas/configv1Dataset'
      type: object
    ConfigV1UpdateDatasetBody:
      properties:
        create_if_missing:
          description: If `true`, the Dataset will be created if it does not already exist, identified by `slug`. If `false`, an error will be returned if the Dataset does not already exist.
          type: boolean
        dataset:
          allOf:
          - $ref: '#/components/schemas/configv1Dataset'
          description: The Dataset to update.
        dry_run:
          description: If `true`, validates the specified configuration without creating or updating the Dataset. If the specified configuration is valid, the endpoint returns a partial response without the Dataset. If the specified configuration is invalid, the endpoint returns an error.
          type: boolean
      type: object
    SpanFilterSpanFilterMatchType:
      enum:
      - INCLUDE
      - EXCLUDE
      type: string
    configv1LogSearchFilter:
      properties:
        query:
          description: 'Returns logs that match this query. The query can include only top-level

            operations. Nested clauses aren''t supported. Only one type of `AND` or `OR`

            operator is allowed.'
          type: string
      type: object
    configv1TraceDataset:
      properties:
        match_criteria:
          allOf:
          - $ref: '#/components/schemas/configv1TraceSearchFilter'
          description: Required. Defines the criteria to match traces to a dataset.
      type: object
    configv1CreateDatasetResponse:
      properties:
        dataset:
          $ref: '#/components/schemas/configv1Dataset'
      type: object
    configv1DeleteDatasetResponse:
      type: object
    StringFilterStringFilterMatchType:
      enum:
      - EXACT
      - REGEX
      - EXACT_NEGATION
      - REGEX_NEGATION
      - IN
      - NOT_IN
      type: string
    configv1Dataset:
      properties:
        configuration:
          allOf:
          - $ref: '#/components/schemas/DatasetDatasetConfiguration'
          description: Required. Defines the configuration of the dataset.
        created_at:
          description: Timestamp of when the Dataset was created. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
        description:
          description: Required. Description of the dataset.
          type: string
        name:
          description: The name of the Dataset. You can modify this value after the Dataset is created.
          type: string
        slug:
          description: The unique identifier of the Dataset. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the Dataset is created.
          type: string
        updated_at:
          description: Timestamp of when the Dataset was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
      required:
      - name
      type: object
    NumericFilterComparisonType:
      enum:
      - EQUAL
      - NOT_EQUAL
      - GREATER_THAN
      - GREATER_THAN_OR_EQUAL
      - LESS_THAN
      - LESS_THAN_OR_EQUAL
      type: string
    configv1ListDatasetsResponse:
      properties:
        datasets:
          items:
            $ref: '#/components/schemas/configv1Dataset'
          type: array
        page:
          $ref: '#/components/schemas/configv1PageResult'
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    configv1UpdateDatasetResponse:
      properties:
        dataset:
          $ref: '#/components/schemas/configv1Dataset'
      type: object
    TraceSearchFilterBoolFilter:
      properties:
        value:
          description: The value of the filter compared to the target trace or span field.
          type: boolean
      type: object
    TraceSearchFilterScopeFilter:
      properties:
        span_scopes:
          description: 'Specifies the span filters that define which spans contribute to the metrics calculation.

            Only spans matching these filters will be included in the metrics aggregation.'
          items:
            $ref: '#/components/schemas/TraceSearchFilterSpanFilter'
          type: array
      type: object
    DatasetDatasetConfiguration:
      properties:
        log_dataset:
          allOf:
          - $ref: '#/components/schemas/configv1LogDataset'
          description: 'If the dataset type is `LOGS`, this configuration defines the semantics for

            the log dataset.'
        trace_dataset:
          allOf:
          - $ref: '#/components/schemas/configv1TraceDataset'
          description: 'If the dataset type is `TRACES`, this configuration defines the semantics for

            the trace dataset.'
        type:
          allOf:
          - $ref: '#/components/schemas/DatasetDatasetType'
          description: The type of dataset.
      type: object
    TraceSearchFilterTraceFilter:
      properties:
        duration:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterDurationFilter'
          description: Matches traces based on the duration of the entire trace.
        error:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterBoolFilter'
          description: Matches traces based on the top-level error status.
      type: object
    TraceSearchFilterCountFilter:
      properties:
        max:
          description: Maximum number of spans that must match a span query, inclusive.
          format: int32
          type: integer
        min:
          description: Minimum number of spans that must match a span query, inclusive.
          format: int32
          type: integer
      type: object
    DatasetDatasetType:
      enum:
      - TRACES
      - LOGS
      type: string
    TraceSearchFilterStringFilter:
      properties:
        in_values:
          description: Values the filter tests against when using `IN` or `NOT_IN` match type.
          items:
            type: string
          type: array
        match:
          allOf:
          - $ref: '#/components/schemas/StringFilterStringFilterMatchType'
          description: 'Specifies the comparison operator for the query. If `EXACT`, compared strings

            must have the exact value of the query value.'
        value:
          description: The value of the filter compared to the target trace or span field.
          type: string
      type: object
    TraceSearchFilterTagFilter:
      properties:
        key:
          description: The key or name of the span tag that this filter inspects.
          type: string
        numeric_value:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterNumericFilter'
          description: 'If the query matches the tag with the specified key, and the value type is

            `numeric`, specifies the matcher used to evaluate the span tag value.'
        value:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterStringFilter'
          description: 'If the query matches the tag with the specified key, and the value type is a

            `string`, specifies the matcher used to evaluate the span tag value.'
      type: object
    TraceSearchFilterDurationFilter:
      properties:
        max_secs:
          description: Maximum duration, in seconds, required for a span or trace to match.
          format: double
          type: number
        min_secs:
          description: Minimum duration, in seconds, required for a span or trace to match.
          format: double
          type: number
      type: object
    configv1PageResult:
      properties:
        next_token:
          description: 'An opaque page token that identifies the next page of items that the

            client should request. An empty value indicates that there are no

            more items to return.'
          type: string
      type: object
    TraceSearchFilterSpanFilter:
      properties:
        duration:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterDurationFilter'
          description: Matches the duration of the candidate span.
        error:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterBoolFilter'
          description: Matches the error status of the candidate span.
        is_root_span:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterBoolFilter'
          description: 'Matches the root span of a trace. For example, if the parent span has no child

            spans.'
        match_type:
          allOf:
          - $ref: '#/components/schemas/SpanFilterSpanFilterMatchType'
          description: 'If `INCLUDE`, includes all traces that have at least one (or `span_count`)

            spans matching the query. If `EXCLUDE`, excludes all traces that have at least

            one (or `span_count`) spans matching the query.'
        operation:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterStringFilter'
          description: Matches the operation of the candidate span.
        parent_operation:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterStringFilter'
          description: If not a root span, matches the operation of the candidate span's parent span
        parent_service:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterStringFilter'
          description: If not a root span, matches the service of the candidate span's parent span.
        service:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterStringFilter'
          description: Matches the service of the candidate span.
        span_count:
          allOf:
          - $ref: '#/components/schemas/TraceSearchFilterCountFilter'
          description: 'Defines the number of spans that must match the criteria defined by the span

            query. Defaults to requiring that at least one span matches the span query.'
        tags:
          description: Matches the tags of the candidate span.
          items:
            $ref: '#/components/schemas/TraceSearchFilterTagFilter'
          type: array
      type: object
    configv1CreateDatasetRequest_2:
      type: object
      properties:
        dataset:
          $ref: '#/components/schemas/configv1Dataset_2'
        dry_run:
          type: boolean
          description: If true, the Dataset isn't created, and no response Dataset will be returned. The response will return an error if the given Dataset is invalid.
    configv1LogDataset_2:
      type: object
      properties:
        match_criteria:
          $ref: '#/components/schemas/configv1LogSearchFilter'
    configv1TraceSearchFilter_2:
      type: object
      properties:
        trace:
          $ref: '#/components/schemas/TraceSearchFilterTraceFilter_2'
        span:
          type: array
          description: 'Specifies the span conditions to match on. All conditions must be true in a

            single span for the span to be considered a match. If `span_count` is specified,

            the number of spans within the trace that match span conditions must be within

            `[min, max]`. You can specify multiple span conditions, and each can be

            satisfied by any number of spans within the trace.'
          items:
            $ref: '#/components/schemas/TraceSearchFilterSpanFilter_2'
    TraceSearchFilterNumericFilter_2:
      type: object
      properties:
        comparison:
          $ref: '#/components/schemas/NumericFilterComparisonType'
        value:
          type: number
          description: The filter value used in comparison against match candidates.
          format: double
    ConfigV1UpdateDatasetBody_2:
      type: object
      properties:
        dataset:
          $ref: '#/components/schemas/configv1Dataset_2'
        create_if_missing:
          type: boolean
          description: If true, the Dataset will be created if it does not already exist, identified by slug. If false, an error will be returned if the Dataset does not already exist.
        dry_run:
          type: boolean
          description: If true, the Dataset isn't created or updated, and no response Dataset will be returned. The response will return an error if the given Dataset is invalid.
    configv1TraceDataset_2:
      type: object
      properties:
        match_criteria:
          $ref: '#/components/schemas/configv1TraceSearchFilter_2'
    configv1Dataset_2:
      type: object
      properties:
        name:
          type: string
          description: Required. Name of the Dataset. You can modify this value after the Dataset is created.
        slug:
          type: string
          description: Unique identifier of the Dataset. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the Dataset is created.
        created_at:
          type: string
          description: Timestamp of when the Dataset was created. Cannot be set by clients.
          format: date-time
          readOnly: true
        updated_at:
          type: string
          description: Timestamp of when the Dataset was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
        description:
          type: string
          description: Required. Description of the dataset.
        configuration:
          $ref: '#/components/schemas/DatasetDatasetConfiguration_2'
    apiError_2:
      type: object
      properties:
        code:
          type: integer
          description: An optional private error code whose values are undefined.
          format: int32
        message:
          type: string
          description: An error message describing what went wrong.
    DatasetDatasetConfiguration_2:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DatasetDatasetType'
        trace_dataset:
          $ref: '#/components/schemas/configv1TraceDataset_2'
        log_dataset:
          $ref: '#/components/schemas/configv1LogDataset_2'
    TraceSearchFilterTraceFilter_2:
      type: object
      properties:
        duration:
          $ref: '#/components/schemas/TraceSearchFilterDurationFilter'
        error:
          $ref: '#/components/schemas/TraceSearchFilterBoolFilter'
    TraceSearchFilterStringFilter_2:
      type: object
      properties:
        match:
          $ref: '#/components/schemas/StringFilterStringFilterMatchType'
        value:
          type: string
          description: The value of the filter compared to the target trace or span field.
        in_values:
          type: array
          description: Values the filter tests against when using `IN` or `NOT_IN` match type.
          items:
            type: string
    TraceSearchFilterTagFilter_2:
      type: object
      properties:
        key:
          type: string
          description: The key or name of the span tag that this filter inspects.
        value:
          $ref: '#/components/schemas/TraceSearchFilterStringFilter_2'
        numeric_value:
          $ref: '#/components/schemas/TraceSearchFilterNumericFilter_2'
    configv1PageResult_2:
      type: object
      properties:
        next_token:
          type: string
          description: 'Opaque page token which identifies the next page of items which the

            client should request. An empty next_token indicates that there are no

            more items to return.'
    TraceSearchFilterSpanFilter_2:
      type: object
      properties:
        match_type:
          $ref: '#/components/schemas/SpanFilterSpanFilterMatchType'
        service:
          $ref: '#/components/schemas/TraceSearchFilterStringFilter_2'
        operation:
          $ref: '#/components/schemas/TraceSearchFilterStringFilter_2'
        parent_service:
          $ref: '#/components/schemas/TraceSearchFilterStringFilter_2'
        parent_operation:
          $ref: '#/components/schemas/TraceSearchFilterStringFilter_2'
        duration:
          $ref: '#/components/schemas/TraceSearchFilterDurationFilter'
        error:
          $ref: '#/components/schemas/TraceSearchFilterBoolFilter'
        tags:
          type: array
          description: Matches the tags of the candidate span.
          items:
            $ref: '#/components/schemas/TraceSearchFilterTagFilter_2'
        span_count:
          $ref: '#/components/schemas/TraceSearchFilterCountFilter'
        is_root_span:
          $ref: '#/components/schemas/TraceSearchFilterBoolFilter'
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey
x-refined-from:
- chronosphere-config-v1-openapi3.json
- chronosphere-openapi.yml