Altimate AI GOVERNANCE API
The GOVERNANCE API from Altimate AI — 8 operation(s) for governance.
OpenAPI Specification
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS GOVERNANCE API
version: 0.1.0
tags:
- name: GOVERNANCE
paths:
/governance/users:
get:
tags:
- GOVERNANCE
summary: Get Users
description: Gets all users
operationId: get_users_governance_users_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Limit
- name: users
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Users
- name: roles
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Roles
- name: insights
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Insights
- name: instance_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Instance Ids
- name: sort_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: total_cost
title: Sort Key
- name: sort_order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: desc
title: Sort Order
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number
default: 1
title: Page
description: Page number
- name: size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Page size
default: 50
title: Size
description: Page size
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Page_GovernanceUserResponse_'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Users Governance Users Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Users Governance Users Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/roles:
get:
tags:
- GOVERNANCE
summary: Get Roles
description: Gets all roles
operationId: get_roles_governance_roles_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Limit
- name: roles
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Roles
- name: insights
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Insights
- name: instance_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Instance Ids
- name: sort_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: total_cost
title: Sort Key
- name: sort_order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: desc
title: Sort Order
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number
default: 1
title: Page
description: Page number
- name: size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Page size
default: 50
title: Size
description: Page size
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Page_GovernanceRoleResponse_'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Roles Governance Roles Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Roles Governance Roles Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/summary:
get:
tags:
- GOVERNANCE
summary: Get Summary
description: Gets all roles
operationId: get_summary_governance_summary_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items: {}
title: Response Get Summary Governance Summary Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Summary Governance Summary Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Summary Governance Summary Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/users/cost:
get:
tags:
- GOVERNANCE
summary: Get Users Cost
description: Gets graph data for users cost
operationId: get_users_cost_governance_users_cost_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: period
in: query
required: false
schema:
type: integer
default: 1
title: Period
- name: user_name
in: query
required: true
schema:
type: string
title: User Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Users Cost Governance Users Cost Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Users Cost Governance Users Cost Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Users Cost Governance Users Cost Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/roles/cost:
get:
tags:
- GOVERNANCE
summary: Get Roles Cost
description: Gets graph data for roles cost
operationId: get_roles_cost_governance_roles_cost_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: period
in: query
required: false
schema:
type: integer
default: 1
title: Period
- name: role_name
in: query
required: true
schema:
type: string
title: Role Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Roles Cost Governance Roles Cost Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Roles Cost Governance Roles Cost Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Roles Cost Governance Roles Cost Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/filters:
get:
tags:
- GOVERNANCE
summary: Get Filters
description: Gets filters
operationId: get_filters_governance_filters_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: entity_type
in: query
required: false
schema:
type: string
default: ''
title: Entity Type
- name: prefix
in: query
required: false
schema:
type: string
default: ''
title: Prefix
- name: page
in: query
required: false
schema:
type: integer
default: 1
title: Page
- name: size
in: query
required: false
schema:
type: integer
default: 50
title: Size
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Filters Governance Filters Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Filters Governance Filters Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Filters Governance Filters Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/users/details/{user_name}:
get:
tags:
- GOVERNANCE
summary: Get Users Detailed
description: Gets detailed user for user_name
operationId: get_users_detailed_governance_users_details__user_name__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: user_name
in: path
required: true
schema:
type: string
title: User Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Users Detailed Governance Users Details User Name Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Users Detailed Governance Users Details User Name Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Users Detailed Governance Users Details User Name Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/governance/roles/details/{role_name}:
get:
tags:
- GOVERNANCE
summary: Get Roles Detailed
description: Gets detailed role for role_name
operationId: get_roles_detailed_governance_roles_details__role_name__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: role_name
in: path
required: true
schema:
type: string
title: Role Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Roles Detailed Governance Roles Details Role Name Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Roles Detailed Governance Roles Details Role Name Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Roles Detailed Governance Roles Details Role Name Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
Page_GovernanceRoleResponse_:
properties:
items:
items:
$ref: '#/components/schemas/GovernanceRoleResponse'
type: array
title: Items
total:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Total
page:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Page
size:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Size
pages:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Pages
type: object
required:
- items
- total
- page
- size
title: Page[GovernanceRoleResponse]
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
GovernanceRoleResponse:
properties:
role_name:
type: string
title: Role Name
total_cost:
type: number
title: Total Cost
max_cost:
type: number
title: Max Cost
num_of_query_groups:
type: string
title: Num Of Query Groups
insights:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Insights
avg_cost:
type: number
title: Avg Cost
instance_id:
anyOf:
- type: integer
- type: 'null'
title: Instance Id
num_of_queries:
type: string
title: Num Of Queries
num_of_adhoc_queries:
type: string
title: Num Of Adhoc Queries
type: object
required:
- role_name
- total_cost
- max_cost
- num_of_query_groups
- avg_cost
- num_of_queries
- num_of_adhoc_queries
title: GovernanceRoleResponse
GovernanceUserResponse:
properties:
user_name:
type: string
title: User Name
total_cost:
type: number
title: Total Cost
max_cost:
type: number
title: Max Cost
num_of_query_groups:
type: string
title: Num Of Query Groups
insights:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Insights
default_role:
anyOf:
- type: string
- type: 'null'
title: Default Role
avg_cost:
type: number
title: Avg Cost
instance_id:
anyOf:
- type: integer
- type: 'null'
title: Instance Id
num_of_queries:
type: string
title: Num Of Queries
num_of_adhoc_queries:
type: string
title: Num Of Adhoc Queries
last_success_login:
type: string
title: Last Success Login
type: object
required:
- user_name
- total_cost
- max_cost
- num_of_query_groups
- avg_cost
- num_of_queries
- num_of_adhoc_queries
- last_success_login
title: GovernanceUserResponse
Page_GovernanceUserResponse_:
properties:
items:
items:
$ref: '#/components/schemas/GovernanceUserResponse'
type: array
title: Items
total:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Total
page:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Page
size:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Size
pages:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Pages
type: object
required:
- items
- total
- page
- size
title: Page[GovernanceUserResponse]
securitySchemes:
HTTPBearer:
type: http
scheme: bearer