Instill AI Metrics API

openapi: 3.2.0
info:
  title: Instill Ai Metrics API
  version: v0.57.0
  contact:
    name: Instill AI
    url: https://github.com/instill-ai
    email: support@instill-ai.com
  license:
    name: MIT
    url: https://github.com/instill-ai/protobufs/blob/main/LICENSE
  description: 'Operations tagged Metrics across 2 of this provider''s published API definitions: service.swagger.yaml, instill-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instill-ai.com
- url: http://api.instill-ai.com
security:
- Bearer: []
tags:
- name: Metrics
  description: Resource usage metrics.
paths:
  /v1beta/pipeline-runs/query-charts:
    get:
      summary: List pipeline trigger time charts
      description: 'Returns a timeline of pipeline trigger counts for a given requester. The

        response will contain one set of records (datapoints), representing the

        amount of triggers in a time bucket.'
      operationId: MgmtPublicService_ListPipelineTriggerChartRecords
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPipelineTriggerChartRecordsResponse'
        '401':
          description: Returned when the client credentials are not valid.
          content:
            application/json:
              schema: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpc.Status'
      parameters:
      - name: requesterId
        description: The ID of the namespace that requested the pipeline triggers.
        in: query
        required: true
        schema:
          type: string
      - name: aggregationWindow
        description: 'Aggregation window. The value is a positive duration string, i.e. a

          sequence of decimal numbers, each with optional fraction and a unit

          suffix, such as "300ms", "1.5h" or "2h45m".

          The minimum (and default) window is 1h.'
        in: query
        required: false
        schema:
          type: string
      - name: start
        description: 'Beginning of the time range from which the records will be fetched.

          The default value is the beginning of the current day, in UTC.'
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: stop
        description: 'End of the time range from which the records will be fetched.

          The default value is the current timestamp.'
        in: query
        required: false
        schema:
          type: string
          format: date-time
      tags:
      - Metrics
      x-stage: beta
    servers:
    - url: https://api.instill-ai.com
    - url: http://api.instill-ai.com
  /v1beta/model-runs/query-charts:
    get:
      summary: List model trigger time charts
      description: 'Returns a timeline of model trigger counts for a given requester. The

        response will contain one set of records (datapoints), representing the

        amount of triggers in a time bucket.'
      operationId: MgmtPublicService_ListModelTriggerChartRecords
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelTriggerChartRecordsResponse'
        '401':
          description: Returned when the client credentials are not valid.
          content:
            application/json:
              schema: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpc.Status'
      parameters:
      - name: requesterId
        description: The ID of the namespace that requested the model triggers.
        in: query
        required: true
        schema:
          type: string
      - name: aggregationWindow
        description: 'Aggregation window. The value is a positive duration string, i.e. a

          sequence of decimal numbers, each with optional fraction and a unit

          suffix, such as "300ms", "1.5h" or "2h45m".

          The minimum (and default) window is 1h.'
        in: query
        required: false
        schema:
          type: string
      - name: start
        description: 'Beginning of the time range from which the records will be fetched.

          The default value is the beginning of the current day, in UTC.'
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: stop
        description: 'End of the time range from which the records will be fetched.

          The default value is the current timestamp.'
        in: query
        required: false
        schema:
          type: string
          format: date-time
      tags:
      - Metrics
      x-stage: beta
    servers:
    - url: https://api.instill-ai.com
    - url: http://api.instill-ai.com
components:
  schemas:
    Any:
      type: object
      properties:
        '@type':
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
      additionalProperties: {}
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    rpc.Status:
      type: object
      properties:
        code:
          type: integer
          format: int32
          description: 'The status code, which should be an enum value of

            [google.rpc.Code][google.rpc.Code].'
        message:
          type: string
          description: 'A developer-facing error message, which should be in English. Any

            user-facing error message should be localized and sent in the

            [google.rpc.Status.details][google.rpc.Status.details] field, or localized

            by the client.'
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/Any'
          description: 'A list of messages that carry the error details.  There is a common set of

            message types for APIs to use.'
      description: 'The `Status` type defines a logical error model that is suitable for

        different programming environments, including REST APIs and RPC APIs. It is

        used by [gRPC](https://github.com/grpc). Each `Status` message contains

        three pieces of data: error code, error message, and error details.


        You can find out more about this error model and how to work with it in the

        [API Design Guide](https://cloud.google.com/apis/design/errors).'
    ListPipelineTriggerChartRecordsResponse:
      type: object
      properties:
        pipelineTriggerChartRecords:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/PipelineTriggerChartRecord'
          description: 'Pipeline trigger counts. Until we allow filtering or grouping by fields

            like pipeline ID, this list will contain only one element with the

            timeline of trigger counts for a given requester, regardless the pipeline

            ID, trigger mode, final status or other fields.'
      description: 'ListPipelineTriggerChartRecordsResponse contains a list of pipeline trigger

        chart records.'
    PipelineTriggerChartRecord:
      type: object
      properties:
        pipelineId:
          type: string
          description: This field will be present when the information is grouped by pipeline.
          readOnly: true
        timeBuckets:
          type: array
          items:
            type: string
            format: date-time
          description: Time buckets.
          readOnly: true
        triggerCounts:
          type: array
          items:
            type: integer
            format: int32
          description: Aggregated trigger count in each time bucket.
          readOnly: true
        requesterId:
          type: string
          description: The ID of the namespace that requested the pipeline triggers.
          readOnly: true
      description: 'PipelineTriggerChartRecord represents a timeline of pipeline triggers. It

        contains a collection of (timestamp, count) pairs that represent the total

        pipeline triggers in a given time bucket.'
    ListModelTriggerChartRecordsResponse:
      type: object
      properties:
        modelTriggerChartRecords:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/ModelTriggerChartRecord'
          description: 'Model trigger counts. Until we allow filtering or grouping by fields

            like model ID, this list will contain only one element with the

            timeline of trigger counts for a given requester, regardless the model

            ID, trigger mode, final status or other fields.'
      description: 'ListModelTriggerChartRecordsResponse contains a list of model trigger

        chart records.'
    ModelTriggerChartRecord:
      type: object
      properties:
        modelId:
          type: string
          description: This field will be present when the information is grouped by model.
          readOnly: true
        timeBuckets:
          type: array
          items:
            type: string
            format: date-time
          description: Time buckets.
          readOnly: true
        triggerCounts:
          type: array
          items:
            type: integer
            format: int32
          description: Aggregated trigger count in each time bucket.
          readOnly: true
        requesterId:
          type: string
          description: The ID of the namespace that requested the model triggers.
          readOnly: true
      description: 'ModelTriggerChartRecord represents a timeline of model triggers. It

        contains a collection of (timestamp, count) pairs that represent the total

        model triggers in a given time bucket.'
  securitySchemes:
    Bearer:
      type: apiKey
      description: Enter the token with the `Bearer ` prefix, e.g. `Bearer instill_sk_***`
      name: Authorization
      in: header
      x-default: Bearer instill_sk_***
externalDocs:
  description: More about Instill Core
  url: https://docs.instill-ai.com
x-refined-from:
- service.swagger.yaml
- instill-ai-openapi.yml