openapi: 3.2.0 info: contact: {} title: Infoworks Rest API V3 Billing Metering Data 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: Billing Metering Data description: '' paths: /billing/daily-metering-data: get: security: - BearerAuth: [] operationId: getDailyMeteringData tags: - Billing Metering Data summary: Get daily billing metering data description: Get daily billing metering data parameters: - name: start-date in: query description: Starting Date - timestamp schema: type: number example: 1578681000000 - name: end-date in: query description: Ending Date - timestamp schema: type: number example: 1674325800000 - name: sort_by in: query description: Sort result on field schema: type: string - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: d57850ad5127a2d7dab870ff usage_date: type: integer example: 1664389800000 average_cores: type: integer example: 0.5678520833333334 cumulative_average_cores: type: integer example: 0.3436064583333336 '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 /billing/billing-information: get: security: - BearerAuth: [] operationId: getBillingInformation tags: - Billing Metering Data summary: Get billing information description: Get billing information parameters: - name: start-date in: query description: Starting Date - timestamp schema: type: number example: 1578681000000 - name: end-date in: query description: Ending Date - timestamp schema: type: number example: 1674325800000 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: oneOf: - type: object properties: id: type: string example: countInfoForJobs jobs_count: type: integer example: 1566 total_time_count: type: integer example: 97.118 - type: object properties: id: type: string example: coresInfoForJobs average_core_hour_sum: type: integer example: 9.500529166666668 average_core_hours: type: integer example: 0.00866046414463689 core_hour_count: type: integer example: 228.01270000000005 - type: object properties: id: type: string example: coresInfoForInteractiveCluster average_core_hours: type: integer example: 24.968809442418717 core_hour_count: type: integer example: 657378.815 total_time_count: type: integer example: 59488.582 '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 /billing/snowflake-daily-metering-data: get: security: - BearerAuth: [] operationId: getSnowflakeDailyMeteringData tags: - Billing Metering Data summary: Get snowflake daily billing metering data description: Get snowflake daily billing metering data parameters: - name: start-date in: query description: Starting Date - timestamp schema: type: number example: 1578681000000 - name: end-date in: query description: Ending Date - timestamp schema: type: number example: 1674325800000 - name: sort_by in: query description: Sort result on field schema: type: string - name: order_by in: query description: order ascending | descending schema: type: string default: asc enum: - asc - desc responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: type: object properties: id: type: string example: d57850ad5127a2d7dab870ff usage_date: type: integer example: 1664389800000 average_daily_credits: type: integer example: 0 '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 /billing/snowflake-billing-information: get: security: - BearerAuth: [] operationId: getSnowflakeBillingInformation tags: - Billing Metering Data summary: Get snowflake billing information description: Get snowflake billing information parameters: - name: start-date in: query description: Starting Date - timestamp schema: type: number example: 1578681000000 - name: end-date in: query description: Ending Date - timestamp schema: type: number example: 1674325800000 responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: creditsInfoForSnowflakeCompute average_daily_credits_count: type: integer example: 18.531307911941045 total_credits_count: type: integer example: 20328.844779399325 '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 /billing/metrics-config: get: security: - BearerAuth: [] operationId: getMetricsConfig tags: - Billing Metering Data summary: Get metrics configuration description: Get metrics configuration responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: object properties: id: type: string example: 63f5c47a16740b2791c3168e last_updated_at: type: integer example: 1675346570657 last_billed_at: type: integer example: 1675348203544 last_cluster_billed_at: type: integer example: 1671544831251 last_updated_workflow: type: integer example: 1675337497773 last_billed_workflow: type: integer example: 1675339205459 last_core_updated_at: type: integer example: 1670956200000 last_updated_db_cleanup_at: type: integer example: 1670869800000 last_refreshed_at: type: integer example: 1677051007969 last_snowflake_metric_updated_at: type: integer example: 1670956200000 last_snowflake_metric_queried_at: type: integer example: 1677051007970 '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 /billing/refresh-billing-details: post: security: - BearerAuth: [] operationId: refreshBillingDetails tags: - Billing Metering Data summary: Submit a request for refreshing billing details description: Submit a request for refreshing billing details responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message '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