Grepr Pipeline Exceptions API

openapi: 3.2.0
info:
  title: Grepr Pipeline Exceptions API
  version: 1.0.0
  description: 'Operations tagged Pipeline Exceptions across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Pipeline Exceptions
paths:
  /v1/pipelines/{pipelineId}/exceptions/estimation-datasets:
    get:
      description: Returns the pipeline's sink datasets, each joined with the dataset's current estimation configuration (or null when the dataset is not opted in). The estimation configuration is per-dataset and shared across every pipeline whose sink targets the same dataset.
      operationId: getEstimationDatasets_1
      parameters:
      - description: Pipeline ID to list estimation datasets for
        example: pipe-prod-1
        in: path
        name: pipelineId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/EstimationDatasetSummary'
                type: array
          description: Estimation dataset summaries retrieved
        '401':
          description: Unauthorized
        '404':
          description: Not Found - Pipeline not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: List estimation-eligible datasets for a pipeline
      tags:
      - Pipeline Exceptions
  /v1/pipelines/{pipelineId}/exceptions/impact-estimation-reset:
    post:
      description: Clears the cached impact percentage and last-updated timestamp on estimation rows in the pipeline's scope. The hourly impact-estimation cycle picks up the cleared rows on its next tick; fresh values appear on a later poll. Rows currently being processed by an active estimation job are skipped and retain their values until that job completes. Returns the number of rows cleared; zero indicates a no-op (no opted-in sink datasets, or no estimation-capable source integrations).
      operationId: resetImpactEstimation
      parameters:
      - description: Pipeline ID to reset estimations for
        example: pipe-prod-1
        in: path
        name: pipelineId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetImpactEstimationResponse'
          description: Reset complete
        '401':
          description: Unauthorized
        '404':
          description: Not Found - Pipeline not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Reset impact estimations for a pipeline
      tags:
      - Pipeline Exceptions
  /v1/pipelines/{pipelineId}/exceptions/integrations/{integrationId}/impacts:
    get:
      description: Returns the per-exception impact percentages the runtime auto-sync threshold filter would compare against for this pipeline/integration pair, each with the time that estimate was measured. The pipeline's sink dataset scopes the lookup; exceptions without an estimation row are absent from the response rather than reported as zero.
      operationId: getIntegrationExceptionImpacts
      parameters:
      - description: Pipeline ID providing the dataset scope
        example: pipe-prod-1
        in: path
        name: pipelineId
        required: true
        schema:
          type: string
      - description: Integration whose exceptions to look up impacts for
        example: int-dd-1
        in: path
        name: integrationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  $ref: '#/components/schemas/ExceptionImpact'
                type: object
          description: Impact percentages retrieved
        '401':
          description: Unauthorized
        '404':
          description: Not Found - Pipeline not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get integration exception impacts for a pipeline
      tags:
      - Pipeline Exceptions
components:
  schemas:
    DatadogQueryPredicate:
      properties:
        query:
          default: ''
          description: The datadog query used by the predicate. See https://docs.datadoghq.com/tracing/trace_explorer/query_syntax
          example: service:grepr-service-1
          type: string
        type:
          description: A predicate that checks if an event matches a datadog query.
          enum:
          - datadog-query
          type: string
      required:
      - query
      - type
      type: object
    PipelineRef:
      properties:
        id:
          description: Pipeline id
          example: pipe-prod-1
          type: string
        name:
          description: Pipeline display name
          example: prod
          type: string
      required:
      - id
      - name
      type: object
    NewRelicQueryPredicate:
      properties:
        query:
          default: ''
          description: 'The New Relic query used by the predicate. See https://docs.newrelic.com/docs/logs/ui-data/query-syntax-logs/ '
          example: service:grepr-service-1
          type: string
        type:
          description: A predicate that checks if an event matches a New Relic query.
          enum:
          - newrelic-query
          type: string
      required:
      - query
      - type
      type: object
    MetricEventPredicate:
      properties:
        filterTags:
          additionalProperties:
            default: {}
            description: The set of tags to query for. If unspecified, all tags are queried.
            example:
              env:
              - prod
              service:
              - my-app
            items:
              default: '{}'
              description: The set of tags to query for. If unspecified, all tags are queried.
              example: '{"service":["my-app"],"env":["prod"]}'
              type: string
            type: array
            uniqueItems: true
          default: {}
          description: The set of tags to query for. If unspecified, all tags are queried.
          example:
            env:
            - prod
            service:
            - my-app
          type: object
        metricNames:
          default: []
          description: The names of the metrics to query. Must not be empty.
          example:
          - cpu.load
          - cpu.utilization
          items:
            description: The names of the metrics to query. Must not be empty.
            example: '["cpu.load","cpu.utilization"]'
            type: string
          maxItems: 2147483647
          minItems: 1
          type: array
        query:
          type: string
        type:
          description: A predicate that checks if an event matches a metrics query.
          enum:
          - metric-predicate
          type: string
      required:
      - metricNames
      - query
      - type
      type: object
    ExceptionImpact:
      description: Estimated passthrough for one parsed alert query against one dataset
      properties:
        measuredAt:
          description: When the estimation run that produced this percentage completed. Absent when the age of the measurement is not known; that is not the same as freshly measured.
          example: '2026-09-09T04:15:00Z'
          format: date-time
          type: string
        percentage:
          description: Estimated percentage of the dataset's raw log volume this query matches. Honouring the query as a pipeline exception passes approximately this share of the data through without aggregation.
          example: 4.27
          format: double
          type: number
      required:
      - percentage
      type: object
    EstimationDatasetSummary:
      properties:
        config:
          $ref: '#/components/schemas/DatasetEstimationConfig'
        datasetId:
          description: Dataset this summary describes
          example: ds-prod-1
          type: string
        datasetName:
          description: Display name of the dataset
          example: logs-prod
          type: string
        pipelines:
          default: []
          items:
            $ref: '#/components/schemas/PipelineRef'
          type: array
      required:
      - datasetId
      - datasetName
      - pipelines
      type: object
    DatasetEstimationConfig:
      properties:
        createdAt:
          format: date-time
          readOnly: true
          type: string
        datasetId:
          readOnly: true
          type: string
        logLimit:
          default: 10000000
          description: Maximum number of log messages to scan per estimation run.
          example: 10000000
          format: int32
          maximum: 2147483647
          type: integer
        lookbackDuration:
          default: PT1H
          description: Time window of data to scan per estimation run. ISO-8601 duration format.
          example: PT20.345S
          format: ISO-8601
          type: string
        organizationId:
          readOnly: true
          type: string
        query:
          $ref: '#/components/schemas/EventPredicate'
        refreshPeriod:
          default: PT168H
          description: How often to recalculate impact percentages. ISO-8601 duration format.
          example: PT20.345S
          format: ISO-8601
          type: string
        updatedAt:
          format: date-time
          readOnly: true
          type: string
      required:
      - logLimit
      - lookbackDuration
      - refreshPeriod
      type: object
    ResetImpactEstimationResponse:
      properties:
        rowsCleared:
          description: Number of estimation rows whose cached impact percentage was cleared. Zero when nothing was in scope (no opted-in sink datasets, or no estimation-capable integrations).
          example: 12
          format: int32
          type: integer
      required:
      - rowsCleared
      type: object
    EventPredicate:
      description: Predicate applied to rows before analytical aggregation.
      discriminator:
        mapping:
          and-predicate: '#/components/schemas/AndEventPredicate'
          datadog-query: '#/components/schemas/DatadogQueryPredicate'
          metric-predicate: '#/components/schemas/MetricEventPredicate'
          newrelic-query: '#/components/schemas/NewRelicQueryPredicate'
          nrql-query: '#/components/schemas/NrqlQueryPredicate'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AndEventPredicate'
      - $ref: '#/components/schemas/DatadogQueryPredicate'
      - $ref: '#/components/schemas/MetricEventPredicate'
      - $ref: '#/components/schemas/NewRelicQueryPredicate'
      - $ref: '#/components/schemas/NrqlQueryPredicate'
      properties:
        query:
          type: string
        type:
          type: string
      required:
      - type
      type: object
    AndEventPredicate:
      properties:
        queries:
          default: []
          description: List of predicates that must all match for this predicate to match.
          items:
            $ref: '#/components/schemas/EventPredicate'
          maxItems: 2147483647
          minItems: 1
          title: Child predicates
          type: array
        type:
          description: A predicate that matches when every child predicate matches.
          enum:
          - and-predicate
          type: string
      required:
      - queries
      - type
      type: object
    NrqlQueryPredicate:
      properties:
        query:
          default: ''
          description: The Nrql query used by the predicate. See https://docs.newrelic.com/docs/nrql
          example: SELECT * FROM Log WHERE service = 'grepr-service-1'
          type: string
        strict:
          default: true
          description: Whether the query should be parsed in strict mode.
          type: boolean
        type:
          description: A predicate that checks if an event matches an NRQL query.
          enum:
          - nrql-query
          type: string
      required:
      - query
      - type
      type: object
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest