@@ -13352,6 +13352,41 @@ components:
13352
13352
$ref: '#/components/schemas/UsageBillableSummaryHour'
13353
13353
type: array
13354
13354
type: object
13355
+ UsageCIVisibilityHour:
13356
+ description: CI visibility usage in a given hour.
13357
+ properties:
13358
+ ci_pipeline_indexed_spans:
13359
+ description: The number of spans for pipelines in the queried hour.
13360
+ type: integer
13361
+ ci_test_indexed_spans:
13362
+ description: The number of spans for tests in the queried hour.
13363
+ type: integer
13364
+ ci_visibility_pipeline_committers:
13365
+ description: Shows the total count of all active Git committers for Pipelines
13366
+ in the current month. A committer is active if they commit at least 3
13367
+ times in a given month.
13368
+ type: integer
13369
+ ci_visibility_test_committers:
13370
+ description: The total count of all active Git committers for tests in the
13371
+ current month. A committer is active if they commit at least 3 times in
13372
+ a given month.
13373
+ type: integer
13374
+ org_name:
13375
+ description: The organization name.
13376
+ type: string
13377
+ public_id:
13378
+ description: The organization public ID.
13379
+ type: string
13380
+ type: object
13381
+ UsageCIVisibilityResponse:
13382
+ description: CI visibility usage response
13383
+ properties:
13384
+ usage:
13385
+ description: Response containing CI visibility usage.
13386
+ items:
13387
+ $ref: '#/components/schemas/UsageCIVisibilityHour'
13388
+ type: array
13389
+ type: object
13355
13390
UsageCWSHour:
13356
13391
description: Cloud Workload Security usage for a given organization for a given
13357
13392
hour.
@@ -14361,6 +14396,26 @@ components:
14361
14396
current date for all organizations.
14362
14397
format: int64
14363
14398
type: integer
14399
+ ci_pipeline_indexed_spans_sum:
14400
+ description: Shows the sum of all CI pipeline indexed spans over all hours
14401
+ in the current month for all organizations.
14402
+ format: int64
14403
+ type: integer
14404
+ ci_test_indexed_spans_sum:
14405
+ description: Shows the sum of all CI test indexed spans over all hours in
14406
+ the current month for all organizations.
14407
+ format: int64
14408
+ type: integer
14409
+ ci_visibility_pipeline_committers_hwm:
14410
+ description: Shows the high-water mark of all CI visibility pipeline committers
14411
+ over all hours in the current month for all organizations.
14412
+ format: int64
14413
+ type: integer
14414
+ ci_visibility_test_committers_hwm:
14415
+ description: Shows the high-water mark of all CI visibility test committers
14416
+ over all hours in the current month for all organizations.
14417
+ format: int64
14418
+ type: integer
14364
14419
container_avg:
14365
14420
description: Shows the average of all distinct containers over all hours
14366
14421
in the current date for all organizations.
@@ -14651,6 +14706,26 @@ components:
14651
14706
current date for the given org.
14652
14707
format: int64
14653
14708
type: integer
14709
+ ci_pipeline_indexed_spans_sum:
14710
+ description: Shows the sum of all CI pipeline indexed spans over all hours
14711
+ in the current date for the given org.
14712
+ format: int64
14713
+ type: integer
14714
+ ci_test_indexed_spans_sum:
14715
+ description: Shows the sum of all CI test indexed spans over all hours in
14716
+ the current date for the given org.
14717
+ format: int64
14718
+ type: integer
14719
+ ci_visibility_pipeline_committers_hwm:
14720
+ description: Shows the high-water mark of all CI visibility pipeline committers
14721
+ over all hours in the current date for the given org.
14722
+ format: int64
14723
+ type: integer
14724
+ ci_visibility_test_committers_hwm:
14725
+ description: Shows the high-water mark of all CI visibility test committers
14726
+ over all hours in the current date for the given org.
14727
+ format: int64
14728
+ type: integer
14654
14729
container_avg:
14655
14730
description: Shows the average of all distinct containers over all hours
14656
14731
in the current date for the given org.
@@ -14947,6 +15022,26 @@ components:
14947
15022
current months for all organizations.
14948
15023
format: int64
14949
15024
type: integer
15025
+ ci_pipeline_indexed_spans_agg_sum:
15026
+ description: Shows the sum of all CI pipeline indexed spans over all hours
15027
+ in the current months for all organizations.
15028
+ format: int64
15029
+ type: integer
15030
+ ci_test_indexed_spans_agg_sum:
15031
+ description: Shows the sum of all CI test indexed spans over all hours in
15032
+ the current months for all organizations.
15033
+ format: int64
15034
+ type: integer
15035
+ ci_visibility_pipeline_committers_hwm_sum:
15036
+ description: Shows the high-water mark of all CI visibility pipeline committers
15037
+ over all hours in the current months for all organizations.
15038
+ format: int64
15039
+ type: integer
15040
+ ci_visibility_test_committers_hwm_sum:
15041
+ description: Shows the high-water mark of all CI visibility test committers
15042
+ over all hours in the current months for all organizations.
15043
+ format: int64
15044
+ type: integer
14950
15045
container_avg_sum:
14951
15046
description: Shows the average of all distinct containers over all hours
14952
15047
in the current months for all organizations.
@@ -25647,6 +25742,66 @@ paths:
25647
25742
x-menu-order: 19
25648
25743
x-undo:
25649
25744
type: safe
25745
+ /api/v1/usage/ci-app:
25746
+ get:
25747
+ description: Get hourly usage for CI Visibility (Tests, Pipeline, Combo, and
25748
+ Spans).
25749
+ operationId: GetUsageCIApp
25750
+ parameters:
25751
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
25752
+ for usage beginning at this hour.'
25753
+ in: query
25754
+ name: start_hr
25755
+ required: true
25756
+ schema:
25757
+ format: date-time
25758
+ type: string
25759
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
25760
+ for usage ending
25761
+
25762
+ **before** this hour.'
25763
+ in: query
25764
+ name: end_hr
25765
+ required: false
25766
+ schema:
25767
+ format: date-time
25768
+ type: string
25769
+ responses:
25770
+ '200':
25771
+ content:
25772
+ application/json;datetime-format=rfc3339:
25773
+ schema:
25774
+ $ref: '#/components/schemas/UsageCIVisibilityResponse'
25775
+ description: OK
25776
+ '400':
25777
+ content:
25778
+ application/json;datetime-format=rfc3339:
25779
+ schema:
25780
+ $ref: '#/components/schemas/APIErrorResponse'
25781
+ description: Bad Request
25782
+ '403':
25783
+ content:
25784
+ application/json;datetime-format=rfc3339:
25785
+ schema:
25786
+ $ref: '#/components/schemas/APIErrorResponse'
25787
+ description: Forbidden - User is not authorized
25788
+ '429':
25789
+ content:
25790
+ application/json;datetime-format=rfc3339:
25791
+ schema:
25792
+ $ref: '#/components/schemas/APIErrorResponse'
25793
+ description: Too many requests
25794
+ security:
25795
+ - apiKeyAuth: []
25796
+ appKeyAuth: []
25797
+ - AuthZ:
25798
+ - usage_read
25799
+ summary: Get hourly usage for CI Visibility
25800
+ tags:
25801
+ - Usage Metering
25802
+ x-menu-order: 38
25803
+ x-undo:
25804
+ type: safe
25650
25805
/api/v1/usage/cspm:
25651
25806
get:
25652
25807
description: Get hourly usage for Cloud Security Posture Management (CSPM).
0 commit comments