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_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 query_tag: type: string format: string '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/jobs/{job_id}/reports/job-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 job metrics with job id. description: Get job 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: 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_record_count: type: string format: string fetch_record_count: type: string format: string job_type: type: string format: string source_id: type: string format: string query_tag: type: string format: string /sources/{source_id}/jobs/{job_id}/reports/export-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 Export Metrics with job id. description: Get Export 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_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 target_table_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 query_tag: type: string format: string '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/reports/table-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: table_group_id in: path description: Table Group Id required: true schema: type: string get: security: - BearerAuth: [] tags: - Metrics summary: Get Metrics for all tables in the source. description: Get Metrics for all tables in the source. 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: Ingestion table metrics result: type: array items: type: object properties: job_duration: type: integer example: 46470 job_id: type: string example: 600a79ed7758f33ee14b755a job_start_time: type: string format: date-time job_end_time: type: string format: date-time job_status: type: string example: SUCCEEDED job_type: type: string example: Infoworks Job type fetch_records_count: type: integer minimum: 0 target_records_count: type: integer minimum: 0 table_id: type: string example: 600a79ed7758f33ee14b755a '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/export-metrics: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: table_id in: path description: Table Id. 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 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 target_table_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 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: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/ingestion-metrics: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: table_id in: path description: Table Id. 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 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 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: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: table_id in: path description: Table Id. required: true schema: type: string - name: source_id in: path description: Source Id. required: true schema: type: string get: security: - BearerAuth: [] tags: - Metrics summary: Get the ingestion-metrics for the table description: Get the ingestion-metrics for the table 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 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: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics/download: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: table_id in: path description: Table Id. required: true schema: type: string - name: source_id in: path description: Source Id. required: true schema: type: string get: security: - BearerAuth: [] tags: - Metrics summary: Download ingestion metrics for the table description: Download ingestion metrics for the table responses: '200': description: Ok. content: application/csv: schema: type: string format: binary application/octet-stream: schema: type: string format: binary '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/:source_id/reports/jobs/ingestion-metrics/download: 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 get: security: - BearerAuth: [] tags: - Metrics summary: Download List of All jobs of this Source and it's artifacts. description: Download List of All jobs of this Source and it's artifacts. responses: '200': description: Ok. content: application/csv: schema: type: string format: binary application/octet-stream: schema: type: string format: binary '400': description: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /sources/{source_id}/tables/{table_id}/reports/export-metrics: parameters: - name: Content-Type in: header description: Http content type required: true schema: type: string - name: table_id in: path description: Table Id. required: true schema: type: string - name: source_id in: path description: Source Id. required: true schema: type: string get: security: - BearerAuth: [] tags: - Metrics summary: Get the export-metrics for the table description: Get the export-metrics for the table 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 target_table_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 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: Bad Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '401': description: Unauthorized Request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '403': description: Forbidden Access content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 '500': description: Internal Server Error content: application/json: schema: type: object properties: errors: type: array items: type: object properties: message: type: string example: Something went wrong detail: type: object properties: {} help: type: string example: https://docs.infoworks.io/api/errors/IW1004 code: type: string example: IW1004 /prodops/metrics: post: security: - BearerAuth: [] tags: - Metrics operationId: MetricsForProdOps summary: Fetch the metrics for a given time period description: Fetch the metrics for a given time period requestBody: content: application/json: schema: oneOf: - type: object required: - date_range properties: date_range: type: object required: - type - unit - value properties: type: type: string example: last unit: type: string enum: - day - hour example: day value: type: integer example: 6 - type: object required: - date_range properties: date_range: type: object required: - type - start_date - end_date properties: type: type: string example: custom start_date: type: integer example: 1652355912000 end_date: type: integer example: 1652355912000 responses: '200': description: Ok. content: application/json: schema: properties: workflow: type: object properties: success: type: integer example: 1739 failed: type: integer example: 1123 inprogress: type: integer example: 11 pending: type: integer example: 2 pipeline: type: object properties: success: type: integer example: 1139 failed: type: integer example: 56 inprogress: type: integer example: 1 pending: type: integer example: 0 onboarding: type: object properties: success: type: integer example: 538 failed: type: integer example: 676 inprogress: type: integer example: 1 pending: type: integer 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 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic