openapi: 3.2.0
info:
  title: Gr4vy Insights - Presets API
  description: The Gr4vy API.
  version: 1.0.0
tags:
- name: Insights - Presets
  description: Manage presets for Insights.
paths:
  /metrics-explorer/{source}/presets:
    get:
      tags:
      - Insights - Presets
      summary: List presets
      description: Get all available presets for a specific source. These presets can be used to quickly set predefined filters.
      operationId: list_metrics_explorer_presets
      security:
      - OAuth2PasswordBearer:
        - metrics-explorer.read
      parameters:
      - name: source
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/MetricsExplorerSource'
          description: Source of the data
          examples:
          - authentication
          - authorization
        description: Source of the data
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetricsExplorerPreset'
                title: Response List Metrics Explorer Presets
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-ignore: true
    post:
      tags:
      - Insights - Presets
      summary: Create a preset
      description: Create a preset with a name, metric and a set of filters.
      operationId: create_metrics_explorer_preset
      security:
      - OAuth2PasswordBearer:
        - metrics-explorer.write
      parameters:
      - name: source
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/MetricsExplorerSource'
          description: Source of the data
          examples:
          - authentication
          - authorization
        description: Source of the data
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricsExplorerPresetCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsExplorerPreset'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-ignore: true
  /metrics-explorer/{source}/presets/{preset_id}:
    put:
      tags:
      - Insights - Presets
      summary: Update a preset
      description: Update a preset. This operation can only update the name of the preset.
      operationId: update_metrics_explorer_preset
      security:
      - OAuth2PasswordBearer:
        - metrics-explorer.write
      parameters:
      - name: source
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/MetricsExplorerSource'
          description: Source of the data
          examples:
          - authentication
          - authorization
        description: Source of the data
      - name: preset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: ID of the preset to update
          examples:
          - 8ce33ea7-7a87-49b7-b661-65653630a185
          title: Preset Id
        description: ID of the preset to update
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricsExplorerPresetUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsExplorerPreset'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-ignore: true
    delete:
      tags:
      - Insights - Presets
      summary: Delete a preset
      description: Delete a preset.
      operationId: delete_metrics_explorer_preset
      security:
      - OAuth2PasswordBearer:
        - metrics-explorer.write
      parameters:
      - name: source
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/MetricsExplorerSource'
          description: Source of the data
          examples:
          - authentication
          - authorization
        description: Source of the data
      - name: preset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: ID of the preset to delete
          examples:
          - 8ce33ea7-7a87-49b7-b661-65653630a185
          title: Preset Id
        description: ID of the preset to delete
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '204':
          description: Preset successfully deleted.
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-ignore: true
components:
  schemas:
    Error401:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `unauthorized`
          default: unauthorized
          examples:
          - unauthorized
        status:
          type: integer
          title: Status
          description: Always `401`.
          default: 401
          examples:
          - 401
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: No valid API authentication found
          examples:
          - No valid API authentication found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error401
    Error404:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `not_found`
          default: not_found
          examples:
          - not_found
        status:
          type: integer
          title: Status
          description: Always `404`.
          default: 404
          examples:
          - 404
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: The resource could not be found
          examples:
          - The resource could not be found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error404
    ErrorLocation:
      type: string
      enum:
      - query
      - body
      - path
      - header
      - unknown
      title: ErrorLocation
    Error425:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_early`
          default: too_early
          examples:
          - too_early
        status:
          type: integer
          title: Status
          description: Always `425`.
          default: 425
          examples:
          - 425
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error425
    MetricsExplorerSource:
      type: string
      enum:
      - authentication
      - authorization
      - monitoring
      title: MetricsExplorerSource
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MetricsExplorerMetric:
      type: string
      enum:
      - volume
      - transactions
      - auth_rate
      title: MetricsExplorerMetric
    ErrorDetail:
      properties:
        location:
          $ref: '#/components/schemas/ErrorLocation'
          description: The part of the request where the property can be found that caused the error.
          examples:
          - body
        pointer:
          anyOf:
          - type: string
            format: json-pointer
          - type: string
          title: Pointer
          description: A JSON pointer for the particular property that caused the error.
          examples:
          - /currency
        message:
          type: string
          title: Message
          description: A human-readdable explanation of the error.
          examples:
          - 'Unknown ISO 4217 currency code: USX'
        type:
          type: string
          title: Type
          description: The type of error that was raised for this property.
          examples:
          - value_error
      additionalProperties: false
      type: object
      required:
      - location
      - pointer
      - message
      - type
      title: ErrorDetail
    MetricsExplorerFiltersQueryParams:
      properties:
        datetime_range:
          type: string
          title: Datetime Range
          description: 'Filters the results to the set of data aggregated over the duration of the specified period. This parameter should be in the format of [ISO 8601 interval](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) while the duration only format is not accepted. Start and end are either a datetime in ISO 8601 format or a placeholder which is one of the following: `now`, `hour_start` and `hour_end`.'
          examples:
          - 2025-01-01T00:00:00/P7D
        authentication_outcome:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Authentication Outcome
          description: Filters the results to only include transactions whose authentication process ended with the specified outcome. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that didn't undergo an authentication process.
          examples:
          - abandoned
        authorized:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Authorized
          description: Filters the results to only include transactions that were authorized (1) or declined (0).
          examples:
          - '1'
        country:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Country
          description: Filters the results to only include transactions that were processed in the specified country. The country code should be in the ISO 3166-1 two letter format. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - GB
        currency:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Currency
          description: Filters the results to only include transactions that were processed in the specified currency. The currency code should be in the ISO 4217 format.<br/>**Important:** This query parameter is **required** when the `metric` is set to `volume`.
          examples:
          - GBP
        error_code:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Error Code
          description: Filters the results to only include transactions that failed with the specified error code. The error code is a string that describes the reason for the failure. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - invalid_credentials
        instrument_type:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Instrument Type
          description: Filters the results to only include transactions that used the specified instrument type. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - network_token
        is_subsequent_payment:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Is Subsequent Payment
          description: Filters the results to only include transactions that are subsequent payments. A subsequent payment is a payment that is made after an initial payment, typically in a subscription or recurring payment scenario. The value should be either "0" (false) or "1" (true).
          examples:
          - '0'
          - '1'
        liability_shifted:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Liability Shifted
          description: Filters the results to only include transactions where liability was shifted (1) or was not shifted (0).
          examples:
          - '0'
          - '1'
        merchant_initiated:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Merchant Initiated
          description: Filters the results to only include transactions that were initiated by the merchant. The value should be either "0" (false) or "1" (true).
          examples:
          - '0'
          - '1'
        metadata:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Metadata
          description: Filters the results to only include transactions that have the specified metadata. The metadata should be in JSON format and contain a single key-value pair.
          examples:
          - key: value
        method:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Method
          description: Filters the results to only include transactions that were processed using the specified payment method. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - card
        payment_method_bin:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Method Bin
          description: Filters the results to only include transactions that used the specified payment method bin. The payment method bin is the first 6 digits of the card number. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - '123456'
        payment_method_card_issuer_name:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Method Card Issuer Name
          description: Filters the results to only include transactions that were processed with the specified card issuer name. The card issuer name is the name of the bank or financial institution that issued the card used for the transaction. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - Barclays
        payment_method_card_type:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Method Card Type
          description: Filters the results to only include transactions that used the specified card type. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - credit
          - debit
          - prepaid
        payment_method_country:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Method Country
          description: Filters the results to only include transactions that were processed with a card issued in the specified country. The country code should be in the ISO 3166-1 two letter format. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - GB
        payment_method_scheme:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Method Scheme
          description: Filters the results to only include transactions that were processed with the specified payment method scheme. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - visa
        payment_service_id:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Service Id
          description: Filters the results to only include transactions that were processed with the specified payment service ID. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - 06319aec-2c0f-4c7b-8af1-047ca037fc021
        payment_source:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Payment Source
          description: Filters the results to only include transactions that were processed with the specified payment source.
          examples:
          - ecommerce
          - recurring
        raw_response_code:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Raw Response Code
          description: Filters the results to only include transactions that received the specified raw response code from the payment service. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - COMPLETED
        rule_id_route_transaction:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Rule Id Route Transaction
          description: Filters the results to only include transactions that were processed with the specified routing rule. The rule ID should be in UUID format. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that were not processed by any routing rule.
          examples:
          - c2fefd1b-6ed0-4038-bbc8-48ea2fb7e9f7
        rule_id_skip_3ds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Rule Id Skip 3Ds
          description: Filters the results to only include transactions that were processed with the specified 3DS rule. The rule ID should be in UUID format. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that were not processed by any 3DS rule.
          examples:
          - c2fefd1b-6ed0-4038-bbc8-48ea2fb7e9f7
        rule_variant_id:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Rule Variant Id
          description: Filters the results to only include transactions that were processed with the specified split routing rule outcome variant. The variant ID should be in UUID format.
          examples:
          - 9897134a-fd29-4b0f-9391-a5cf965f0859
        three_d_secure_auth_resp:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Three D Secure Auth Resp
          description: Filters the results to only include transactions that received the specified response during 3DS authentication. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - Y
        three_d_secure_eci:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Three D Secure Eci
          description: Filters the results to only include transactions that received the specified ECI during 3DS authentication. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that have a null for this field.
          examples:
          - '05'
        three_d_secure_method:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Three D Secure Method
          description: Filters the results to only include transactions that underwent 3DS authentication with the specified method. This parameter also accepts [the null character](https://en.wikipedia.org/wiki/Null_character) to include transactions that didn't undergo 3DS authentication.
          examples:
          - challenge
          - frictionless
      type: object
      required:
      - datetime_range
      title: MetricsExplorerFiltersQueryParams
    Error405:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `method_not_allowed`
          default: method_not_allowed
          examples:
          - method_not_allowed
        status:
          type: integer
          title: Status
          description: Always `405`.
          default: 405
          examples:
          - 405
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Method Not Allowed
          examples:
          - Method Not Allowed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error405
    Error429:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_many_requests`
          default: too_many_requests
          examples:
          - too_many_requests
        status:
          type: integer
          title: Status
          description: Always `429`.
          default: 429
          examples:
          - 429
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error429
    MetricsExplorerPreset:
      properties:
        type:
          type: string
          const: metrics-explorer.preset
          title: Type
          description: Always `metrics-explorer.preset`.
          default: metrics-explorer.preset
          examples:
          - metrics-explorer.preset
        id:
          type: string
          format: uuid
          title: Id
          description: The ID of the preset.
          examples:
          - 5d8444cb-bcc2-4ebb-b563-9c9e486f8876
        merchant_account_id:
          type: string
          title: Merchant Account Id
          description: The ID of the merchant account associated with the preset.
          examples:
          - default
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date and time when the preset was created.
          examples:
          - '2025-03-25T00:00:00Z'
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: The date and time when the preset was last updated.
          examples:
          - '2025-03-25T00:00:00Z'
        display_name:
          type: string
          title: Display Name
          description: The display name for the preset.
          examples:
          - Stripe (US) - Last 7 Days
        source:
          $ref: '#/components/schemas/MetricsExplorerSource'
          description: The source of the data.
          examples:
          - authentication
        metric:
          $ref: '#/components/schemas/MetricsExplorerMetric'
          description: The metric to calculate.
          examples:
          - auth_rate
          - transactions
          - volume
        filters:
          additionalProperties:
            anyOf:
            - type: string
            - items:
                type: string
              type: array
          type: object
          title: Filters
          description: The filters to apply on data.
          examples:
          - authentication_outcome:
            - abandoned
            datetime_range: P7D/hour_start
      additionalProperties: false
      type: object
      required:
      - id
      - merchant_account_id
      - created_at
      - updated_at
      - display_name
      - source
      - metric
      - filters
      title: MetricsExplorerPreset
    Error500:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `server_error`
          default: server_error
          examples:
          - server_error
        status:
          type: integer
          title: Status
          description: Always `500`.
          default: 500
          examples:
          - 500
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error500
    Error504:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `gateway_timeout`
          default: gateway_timeout
          examples:
          - gateway_timeout
        status:
          type: integer
          title: Status
          default: 504
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error504
    MetricsExplorerPresetUpdate:
      properties:
        display_name:
          type: string
          maxLength: 255
          minLength: 1
          title: Display Name
          description: The new display name to set on the preset.
          examples:
          - UK card transactions - Last 7 Days
      additionalProperties: false
      type: object
      required:
      - display_name
      title: MetricsExplorerPresetUpdate
    Error400:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_request`
          default: bad_request
          examples:
          - bad_request
        status:
          type: integer
          title: Status
          description: Always `400`.
          default: 400
          examples:
          - 400
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error400
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Error502:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_gateway`
          default: bad_gateway
          examples:
          - bad_gateway
        status:
          type: integer
          title: Status
          description: Always `502`.
          default: 502
          examples:
          - 502
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error502
    Error409:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `duplicate_record`
          default: duplicate_record
          examples:
          - duplicate_record
        status:
          type: integer
          title: Status
          description: Always `409`.
          default: 409
          examples:
          - 409
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: The ID of the conflicting resource.
          examples:
          - cdc70639-cb9c-4222-a73f-b8ce39f7821b
      additionalProperties: false
      type: object
      title: Error409
    Error403:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `forbidden`
          default: forbidden
          examples:
          - forbidden
        status:
          type: integer
          title: Status
          description: Always `403`.
          default: 403
          examples:
          - 403
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error403
    MetricsExplorerPresetCreate:
      properties:
        display_name:
          type: string
          maxLength: 255
          minLength: 1
          title: Display Name
          description: The display name for the preset.
          examples:
          - UK transactions - Last 7 Days
        metric:
          $ref: '#/components/schemas/MetricsExplorerMetric'
          description: The metric to calculate.
          examples:
          - auth_rate
          - transactions
          - volume
        filters:
          $ref: '#/components/schemas/MetricsExplorerFiltersQueryParams'
          description: The filters to apply on data.
          examples:
          - country:
            - GB
            datetime_range: P7D/hour_start
      additionalProperties: false
      type: object
      required:
      - display_name
      - metric
      - filters
      title: MetricsExplorerPresetCreate
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            embed: Shorthand for all gr4vy embed related scopes
            sessions.refresh: Refresh access-token
            anti-fraud-service-definitions.read: Read Anti Fraud Service Definitions
            anti-fraud-services.read: Read Anti Fraud Services
            api-key-pairs.read: Read API Key Pairs
            api-logs.read: Read API Logs
            apple-pay-certificates.read: Read Apple Pay Certificates
            audit-logs.read: Read Audit Logs
            bin-checker.read: Read BIN Checker
            buyers.read: Read Buyers
            buyers.billing-details.read: Read Billing Details
            card-scheme-definitions.read: Read Card Scheme Definitions
            checkout-sessions.read: Read Checkout Sessions
            connections.read: Read Connections
            digital-wallets.read: Read Digital Wallets
            flows.read: Read Flows
            gift-card-service-definitions.read: Read Gift Card Service Definitions
            gift-card-services.read: Read Gift Card Services
            gift-cards.read: Read Gift Cards
            merchant-accounts.read: Read Merchant Accounts
            payment-links.read: Read Payment Links
            payment-method-definitions.read: Read Payment Method Definitions
            payment-methods.read: Read Payment Methods
            payment-options.read: Read Payment Options
            payment-service-definitions.read: Read Payment Service Definitions
            payment-services.read: Read Payment Service
            payouts.read: Read Payouts
            reports.read: Read Reports
            roles.read: Read Roles
            three-ds-scenarios.read: Read 3DS Scenarios
            transactions.read: Read Transactions
            users.me.read: Read User Profile
            vault-forward.read: Read Vault Forward
            vault-forward-authentications.read: Read Vault Forward Authentications
            vault-forward-configs.read: Read Vault Forward Configurations
            vault-forward-definitions.read: Read Vault Forward Definitions
            webhook-subscriptions.read: Read Webhook Subscriptions
            business-contexts.read: Read Business Contexts
            health-dashboard.read: Read Health Dashboard
            metrics-explorer.read: Read Metrics Explorer
            monitoring.read: Read Monitoring
            reset.read: Read Reset
            sessions.read: Read Sessions
            users.read: Read Users
            anti-fraud-service-definitions.write: Write Anti Fraud Service Definitions
            anti-fraud-services.write: Write Anti Fraud Services
            api-key-pairs.write: Write API Key Pairs
            api-logs.write: Write API Logs
            apple-pay-certificates.write: Write Apple Pay Certificates
            audit-logs.write: Write Audit Logs
            bin-checker.write: Write BIN Checker
            buyers.write: Write Buyers
            buyers.billing-details.write: Write Billing Details
            card-scheme-definitions.write: Write Card Scheme Definitions
            checkout-sessions.write: Write Checkout Sessions
            connections.write: Write Connections
            digital-wallets.write: Write Digital Wallets
            flows.write: Write Flows
            gift-card-service-definitions.write: Write Gift Card Service Definitions
            gift-card-services.write: Write Gift Card Services
            gift-cards.write: Write Gift Cards
            merchant-accounts.write: Write Merchant Accounts
            payment-links.write: Write Payment Links
            payment-method-definitions.write: Write Payment Method Definitions
            payment-methods.write: Write Payment Methods
            payment-options.write: Write Payment Options
            payment-service-definitions.write: Write Payment Service Definitions
            payment-services.write: Write Payment Service
            payouts.write: Write Payouts
            reports.write: Write Reports
            roles.write: Write Roles
            three-ds-scenarios.write: Write 3DS Scenarios
            transactions.write: Write Transactions
            users.me.write: Write User Profile
            vault-forward.write: Write Vault Forward
            vault-forward-authentications.write: Write Vault Forward Authentications
            vault-forward-configs.write: Write Vault Forward Configurations
            vault-forward-definitions.write: Write Vault Forward Definitions
            webhook-subscriptions.write: Write Webhook Subscriptions
            business-contexts.write: Write Business Contexts
            health-dashboard.write: Write Health Dashboard
            metrics-explorer.write: Write Metrics Explorer
            monitoring.write: Write Monitoring
            reset.write: Write Reset
            sessions.write: Write Sessions
            users.write: Write Users
          tokenUrl: auth/token