Infoworks

Infoworks Metrics API

The Metrics API from Infoworks — 15 operation(s) for metrics.

GitHub OpenAPI

Operations 15

GET /admin/jobs/{job_id}/reports/ingestion-metrics Get the Ingestion-metrics of the table with job_id
GET /admin/jobs/{job_id}/reports/export-metrics Get the Export-metrics of the table with job_id
GET /admin/jobs/{job_id}/reports/pipeline-metrics Get the Pipeline-metrics of the table with job_id
GET /admin/job-status-metrics Get Job Status Metrics #
GET /sources/{source_id}/jobs/{job_id}/reports/ingestion-metrics Get Ingestion Metrics with job id.
GET /sources/{source_id}/jobs/{job_id}/reports/job-metrics Get job metrics with job id.
GET /sources/{source_id}/jobs/{job_id}/reports/export-metrics Get Export Metrics with job id.
GET /sources/{source_id}/reports/table-metrics Get Metrics for all tables in the source.
GET /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/export-metrics Get the Export-metrics of the table with job id
GET /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/ingestion-metrics Get the ingestion-metrics of the table with job id
GET /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics Get the ingestion-metrics for the table
GET /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics/download Download ingestion metrics for the table
GET /sources/:source_id/reports/jobs/ingestion-metrics/download Download List of All jobs of this Source and it's artifacts.
GET /sources/{source_id}/tables/{table_id}/reports/export-metrics Get the export-metrics for the table
POST /prodops/metrics Fetch the metrics for a given time period #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-metrics-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/infoworks-metrics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

infoworks-metrics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Metrics API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Metrics
paths:
  /admin/jobs/{job_id}/reports/ingestion-metrics:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    - name: job_id
      in: path
      description: Job Id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Metrics
      summary: Get the Ingestion-metrics of the table with job_id
      description: Get the Ingestion-metrics of the table with job_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        properties:
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                number_of_records_written:
                                  type: integer
                                  format: integer
                                number_of_records_read:
                                  type: integer
                                  format: integer
                                last_merged_watermark:
                                  type: string
                                  format: string
                                first_merged_watermark:
                                  type: string
                                  format: string
                                source_table_name:
                                  type: string
                                  format: string
                                source_schema_name:
                                  type: string
                                  format: string
                                source_database_name:
                                  type: string
                                  format: string
                                workflow_run_id:
                                  type: string
                                  format: string
                                workflow_id:
                                  type: string
                                  format: string
                                job_duration:
                                  type: string
                                  format: string
                                job_end_time:
                                  type: string
                                  format: string
                                job_id:
                                  type: string
                                  format: string
                                job_start_time:
                                  type: string
                                  format: string
                                table_id:
                                  type: string
                                  format: string
                                job_status:
                                  type: string
                                  format: string
                                target_records_count:
                                  type: string
                                  format: string
                                fetch_records_count:
                                  type: string
                                  format: string
                                job_type:
                                  type: string
                                  format: string
                                source_id:
                                  type: string
                                  format: string
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/reports/export-metrics:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    - name: job_id
      in: path
      description: Job Id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Metrics
      summary: Get the Export-metrics of the table with job_id
      description: Get the Export-metrics of the table with job_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        properties:
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                number_of_records_written:
                                  type: integer
                                  format: integer
                                number_of_records_read:
                                  type: integer
                                  format: integer
                                last_merged_watermark:
                                  type: string
                                  format: string
                                first_merged_watermark:
                                  type: string
                                  format: string
                                source_table_name:
                                  type: string
                                  format: string
                                source_schema_name:
                                  type: string
                                  format: string
                                source_database_name:
                                  type: string
                                  format: string
                                workflow_run_id:
                                  type: string
                                  format: string
                                workflow_id:
                                  type: string
                                  format: string
                                job_duration:
                                  type: string
                                  format: string
                                job_end_time:
                                  type: string
                                  format: string
                                job_id:
                                  type: string
                                  format: string
                                job_start_time:
                                  type: string
                                  format: string
                                table_id:
                                  type: string
                                  format: string
                                job_status:
                                  type: string
                                  format: string
                                target_records_count:
                                  type: string
                                  format: string
                                job_type:
                                  type: string
                                  format: string
                                source_id:
                                  type: string
                                  format: string
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/reports/pipeline-metrics:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    - name: job_id
      in: path
      description: Job Id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Metrics
      summary: Get the Pipeline-metrics of the table with job_id
      description: Get the Pipeline-metrics of the table with job_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        properties:
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                number_of_records_written:
                                  type: integer
                                  format: integer
                                number_of_records_read:
                                  type: integer
                                  format: integer
                                last_merged_watermark:
                                  type: string
                                  format: string
                                first_merged_watermark:
                                  type: string
                                  format: string
                                source_table_name:
                                  type: string
                                  format: string
                                source_schema_name:
                                  type: string
                                  format: string
                                workflow_run_id:
                                  type: string
                                  format: string
                                workflow_id:
                                  type: string
                                  format: string
                                job_end_time:
                                  type: string
                                  format: string
                                job_id:
                                  type: string
                                  format: string
                                job_start_time:
                                  type: string
                                  format: string
                                job_status:
                                  type: string
                                  format: string
                                target_records_count:
                                  type: string
                                  format: string
                                query_tag:
                                  type: string
                                  format: string
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/job-status-metrics:
    get:
      parameters:
      - name: created_at_window
        in: query
        description: Job run in last some hours.
        required: false
        schema:
          type: integer
          format: int32
          default: 24
      - name: count
        in: query
        description: Number of last jobs to make a query to return.
        required: false
        schema:
          type: integer
          format: int32
          default: 50
      - name: status
        in: query
        description: Comma-separated list of job statuses to filter by.
        required: false
        schema:
          type: string
          enum:
          - running
          - blocked
          - pending
          - completed
          - failed
          - canceled
      security:
      - BearerAuth: []
      operationId: getJobStatusMetrics
      tags:
      - Metrics
      summary: Get Job Status Metrics
      description: Get Job Status Metrics
      responses:
        '200':
          description: Successful response with job status metrics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      job_status_metrics:
                        type: array
                        items:
                          type: object
                          properties:
                            count:
                              type: integer
                              description: Number of jobs in the given status
                            status:
                              type: string
                              description: Job status (e.g., canceled, completed, failed)
                            average_run_time:
                              type: integer
                              description: Average runtime of jobs in milliseconds
                            longest_run_time:
                              type: integer
                              description: Longest runtime of a job in milliseconds
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/jobs/{job_id}/reports/ingestion-metrics:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: job_id
      in: path
      description: Job Id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Metrics
      summary: Get Ingestion Metrics with job id.
      description: Get Ingestion Metrics with job id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        properties:
                          number_of_records_writ

# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-metrics-api-openapi.yml