API docs by Redocly

CISO Assistant API — Analytics & Metrology (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

builtin-metric-samples

metrology_builtin_metric_samples_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
content_type
Array of integers
date
string <date>
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

object_id
string <uuid>
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

metrology_builtin_metric_samples_create

API endpoint that allows builtin metric samples to be viewed. These are system-computed metrics for objects like ComplianceAssessment, RiskAssessment, FindingsAssessment, and Folder.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
object_id
required
string <uuid>

The ID of the object this metric is computed for

date
required
string <date>

The date this snapshot was recorded

metrics
any

All computed metrics for this object. Format depends on object type (e.g., progress, result_breakdown, etc.)

content_type
required
integer

The type of object this metric is computed for

Responses

Request samples

Content type
{
  • "is_published": true,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "date": "2019-08-24",
  • "metrics": null,
  • "content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "date": "2019-08-24",
  • "metrics": null,
  • "content_type": 0
}

metrology_builtin_metric_samples_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Builtin metric sample.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content_type": 0,
  • "content_type_display": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "object_name": "string",
  • "date": "2019-08-24",
  • "metrics": null,
  • "available_metrics": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

metrology_builtin_metric_samples_update

API endpoint that allows builtin metric samples to be viewed. These are system-computed metrics for objects like ComplianceAssessment, RiskAssessment, FindingsAssessment, and Folder.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Builtin metric sample.

Request Body schema:
required
is_published
boolean (Published)
object_id
required
string <uuid>

The ID of the object this metric is computed for

date
required
string <date>

The date this snapshot was recorded

metrics
any

All computed metrics for this object. Format depends on object type (e.g., progress, result_breakdown, etc.)

content_type
required
integer

The type of object this metric is computed for

Responses

Request samples

Content type
{
  • "is_published": true,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "date": "2019-08-24",
  • "metrics": null,
  • "content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "date": "2019-08-24",
  • "metrics": null,
  • "content_type": 0
}

metrology_builtin_metric_samples_partial_update

API endpoint that allows builtin metric samples to be viewed. These are system-computed metrics for objects like ComplianceAssessment, RiskAssessment, FindingsAssessment, and Folder.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Builtin metric sample.

Request Body schema:
is_published
boolean (Published)
object_id
string <uuid>

The ID of the object this metric is computed for

date
string <date>

The date this snapshot was recorded

metrics
any

All computed metrics for this object. Format depends on object type (e.g., progress, result_breakdown, etc.)

content_type
integer

The type of object this metric is computed for

Responses

Request samples

Content type
{
  • "is_published": true,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "date": "2019-08-24",
  • "metrics": null,
  • "content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "date": "2019-08-24",
  • "metrics": null,
  • "content_type": 0
}

metrology_builtin_metric_samples_destroy

API endpoint that allows builtin metric samples to be viewed. These are system-computed metrics for objects like ComplianceAssessment, RiskAssessment, FindingsAssessment, and Folder.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Builtin metric sample.

Responses

metrology_builtin_metric_samples_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Builtin metric sample.

Responses

metrology_builtin_metric_samples_object_retrieve

API endpoint that allows builtin metric samples to be viewed. These are system-computed metrics for objects like ComplianceAssessment, RiskAssessment, FindingsAssessment, and Folder.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Builtin metric sample.

Responses

metrology_builtin_metric_samples_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

metrology_builtin_metric_samples_for_object_retrieve

Get all metric samples for a specific object. Query params:

  • content_type_id: The ContentType ID
  • object_id: The object's UUID
  • OR -
  • model: Model name (e.g., ComplianceAssessment)
  • object_id: The object's UUID
Authorizations:
knoxApiToken

Responses

metrology_builtin_metric_samples_refresh_create

Force refresh metrics for a specific object. Body:

  • content_type_id: The ContentType ID
  • object_id: The object's UUID
  • OR -
  • model: Model name (e.g., ComplianceAssessment)
  • object_id: The object's UUID
Authorizations:
knoxApiToken

Responses

metrology_builtin_metric_samples_supported_models_retrieve

Returns list of models that support builtin metrics with their available metrics. Includes chart_types for each metric based on the metric type.

Authorizations:
knoxApiToken

Responses

custom-metric-samples

metrology_custom_metric_samples_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
evidence_revision
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

metric_instance
Array of strings <uuid> [ items <uuid > ]
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

metrology_custom_metric_samples_create

API endpoint that allows custom metric samples to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
timestamp
required
string <date-time>

When the metric sample was recorded

value
any

The metric value (format depends on metric definition category)

observation
string or null
metric_instance
required
string <uuid>
evidence_revision
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "evidence_revision": "e0bad448-6006-42c2-961b-3d2f3042ffb5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "evidence_revision": "e0bad448-6006-42c2-961b-3d2f3042ffb5"
}

metrology_custom_metric_samples_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Custom metric sample.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "metric_instance": "string",
  • "evidence_revision": "string",
  • "display_value": "string",
  • "raw_value": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string"
}

metrology_custom_metric_samples_update

API endpoint that allows custom metric samples to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Custom metric sample.

Request Body schema:
required
is_published
boolean (Published)
timestamp
required
string <date-time>

When the metric sample was recorded

value
any

The metric value (format depends on metric definition category)

observation
string or null
metric_instance
required
string <uuid>
evidence_revision
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "evidence_revision": "e0bad448-6006-42c2-961b-3d2f3042ffb5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "evidence_revision": "e0bad448-6006-42c2-961b-3d2f3042ffb5"
}

metrology_custom_metric_samples_partial_update

API endpoint that allows custom metric samples to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Custom metric sample.

Request Body schema:
is_published
boolean (Published)
timestamp
string <date-time>

When the metric sample was recorded

value
any

The metric value (format depends on metric definition category)

observation
string or null
metric_instance
string <uuid>
evidence_revision
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "evidence_revision": "e0bad448-6006-42c2-961b-3d2f3042ffb5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": null,
  • "observation": "string",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "evidence_revision": "e0bad448-6006-42c2-961b-3d2f3042ffb5"
}

metrology_custom_metric_samples_destroy

API endpoint that allows custom metric samples to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Custom metric sample.

Responses

metrology_custom_metric_samples_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Custom metric sample.

Responses

metrology_custom_metric_samples_object_retrieve

API endpoint that allows custom metric samples to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Custom metric sample.

Responses

metrology_custom_metric_samples_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

dashboard-widgets

metrology_dashboard_widgets_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
aggregation
Array of strings
Items Enum: "avg" "count" "last" "max" "min" "none" "sum"
  • none - None (Raw Data)
  • avg - Average
  • sum - Sum
  • min - Minimum
  • max - Maximum
  • count - Count
  • last - Last Value
chart_type
Array of strings
Items Enum: "area" "bar" "donut" "gauge" "kpi_card" "line" "pie" "sparkline" "table" "text"
  • kpi_card - KPI Card
  • donut - Donut Chart
  • pie - Pie Chart
  • bar - Bar Chart
  • line - Line Chart
  • area - Area Chart
  • gauge - Gauge
  • sparkline - Sparkline
  • table - Table
  • text - Text
dashboard
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

metric_instance
Array of strings <uuid> [ items <uuid > ]
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

time_range
Array of strings
Items Enum: "all_time" "custom" "last_24_hours" "last_30_days" "last_7_days" "last_90_days" "last_hour" "last_year"
  • last_hour - Last Hour
  • last_24_hours - Last 24 Hours
  • last_7_days - Last 7 Days
  • last_30_days - Last 30 Days
  • last_90_days - Last 90 Days
  • last_year - Last Year
  • all_time - All Time
  • custom - Custom Range

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

metrology_dashboard_widgets_create

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
target_model
string or null
is_published
boolean (Published)
target_object_id
string or null <uuid>

For builtin metrics: the ID of the specific object

metric_key
string or null <= 100 characters

For builtin metrics: which metric to display (e.g., 'progress', 'result_breakdown')

title
string or null <= 200 characters

Custom title for the widget. If empty, uses metric instance name or metric key.

text_content
string or null

Markdown content for text widgets

position_x
integer <int64> [ 0 .. 9223372036854776000 ]

Horizontal position in grid (0-11)

position_y
integer <int64> [ 0 .. 9223372036854776000 ]

Vertical position in grid (row number)

width
integer <int64> [ 0 .. 9223372036854776000 ]

Width in grid columns (1-12)

height
integer <int64> [ 0 .. 9223372036854776000 ]

Height in grid rows

chart_type
string (ChartTypeEnum)
Enum: "kpi_card" "donut" "pie" "bar" "line" "area" "gauge" "sparkline" "table" "text"
  • kpi_card - KPI Card
  • donut - Donut Chart
  • pie - Pie Chart
  • bar - Bar Chart
  • line - Line Chart
  • area - Area Chart
  • gauge - Gauge
  • sparkline - Sparkline
  • table - Table
  • text - Text
time_range
string (TimeRangeEnum)
Enum: "last_hour" "last_24_hours" "last_7_days" "last_30_days" "last_90_days" "last_year" "all_time" "custom"
  • last_hour - Last Hour
  • last_24_hours - Last 24 Hours
  • last_7_days - Last 7 Days
  • last_30_days - Last 30 Days
  • last_90_days - Last 90 Days
  • last_year - Last Year
  • all_time - All Time
  • custom - Custom Range
aggregation
string (AggregationEnum)
Enum: "none" "avg" "sum" "min" "max" "count" "last"
  • none - None (Raw Data)
  • avg - Average
  • sum - Sum
  • min - Minimum
  • max - Maximum
  • count - Count
  • last - Last Value
show_target
boolean

Display target value line if defined on metric instance

show_legend
boolean (Show title and legend)

Display widget title bar and legend (for charts)

widget_config
any

Additional widget configuration. Format: {'color_scheme': 'default', 'threshold_colors': {...}, 'custom_options': {...}}

folder
string <uuid>
dashboard
required
string <uuid>
metric_instance
string or null <uuid>

For custom metrics: the metric instance to display

target_content_type
integer or null

For builtin metrics: the type of object (e.g., ComplianceAssessment)

Responses

Request samples

Content type
{
  • "target_model": "string",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "dashboard": "3433706f-318c-4403-80ab-a3125b1dbb42",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "target_content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "target_content_type_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "dashboard": "3433706f-318c-4403-80ab-a3125b1dbb42",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "target_content_type": 0
}

metrology_dashboard_widgets_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard widget.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "dashboard": "string",
  • "metric_instance": "string",
  • "display_title": "string",
  • "chart_type_display": "string",
  • "time_range_display": "string",
  • "aggregation_display": "string",
  • "is_builtin_metric": true,
  • "is_custom_metric": true,
  • "is_text_widget": true,
  • "target_content_type_display": "string",
  • "target_object_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "target_content_type": 0
}

metrology_dashboard_widgets_update

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard widget.

Request Body schema:
required
target_model
string or null
is_published
boolean (Published)
target_object_id
string or null <uuid>

For builtin metrics: the ID of the specific object

metric_key
string or null <= 100 characters

For builtin metrics: which metric to display (e.g., 'progress', 'result_breakdown')

title
string or null <= 200 characters

Custom title for the widget. If empty, uses metric instance name or metric key.

text_content
string or null

Markdown content for text widgets

position_x
integer <int64> [ 0 .. 9223372036854776000 ]

Horizontal position in grid (0-11)

position_y
integer <int64> [ 0 .. 9223372036854776000 ]

Vertical position in grid (row number)

width
integer <int64> [ 0 .. 9223372036854776000 ]

Width in grid columns (1-12)

height
integer <int64> [ 0 .. 9223372036854776000 ]

Height in grid rows

chart_type
string (ChartTypeEnum)
Enum: "kpi_card" "donut" "pie" "bar" "line" "area" "gauge" "sparkline" "table" "text"
  • kpi_card - KPI Card
  • donut - Donut Chart
  • pie - Pie Chart
  • bar - Bar Chart
  • line - Line Chart
  • area - Area Chart
  • gauge - Gauge
  • sparkline - Sparkline
  • table - Table
  • text - Text
time_range
string (TimeRangeEnum)
Enum: "last_hour" "last_24_hours" "last_7_days" "last_30_days" "last_90_days" "last_year" "all_time" "custom"
  • last_hour - Last Hour
  • last_24_hours - Last 24 Hours
  • last_7_days - Last 7 Days
  • last_30_days - Last 30 Days
  • last_90_days - Last 90 Days
  • last_year - Last Year
  • all_time - All Time
  • custom - Custom Range
aggregation
string (AggregationEnum)
Enum: "none" "avg" "sum" "min" "max" "count" "last"
  • none - None (Raw Data)
  • avg - Average
  • sum - Sum
  • min - Minimum
  • max - Maximum
  • count - Count
  • last - Last Value
show_target
boolean

Display target value line if defined on metric instance

show_legend
boolean (Show title and legend)

Display widget title bar and legend (for charts)

widget_config
any

Additional widget configuration. Format: {'color_scheme': 'default', 'threshold_colors': {...}, 'custom_options': {...}}

folder
string <uuid>
dashboard
required
string <uuid>
metric_instance
string or null <uuid>

For custom metrics: the metric instance to display

target_content_type
integer or null

For builtin metrics: the type of object (e.g., ComplianceAssessment)

Responses

Request samples

Content type
{
  • "target_model": "string",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "dashboard": "3433706f-318c-4403-80ab-a3125b1dbb42",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "target_content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "target_content_type_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "dashboard": "3433706f-318c-4403-80ab-a3125b1dbb42",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "target_content_type": 0
}

metrology_dashboard_widgets_partial_update

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard widget.

Request Body schema:
target_model
string or null
is_published
boolean (Published)
target_object_id
string or null <uuid>

For builtin metrics: the ID of the specific object

metric_key
string or null <= 100 characters

For builtin metrics: which metric to display (e.g., 'progress', 'result_breakdown')

title
string or null <= 200 characters

Custom title for the widget. If empty, uses metric instance name or metric key.

text_content
string or null

Markdown content for text widgets

position_x
integer <int64> [ 0 .. 9223372036854776000 ]

Horizontal position in grid (0-11)

position_y
integer <int64> [ 0 .. 9223372036854776000 ]

Vertical position in grid (row number)

width
integer <int64> [ 0 .. 9223372036854776000 ]

Width in grid columns (1-12)

height
integer <int64> [ 0 .. 9223372036854776000 ]

Height in grid rows

chart_type
string (ChartTypeEnum)
Enum: "kpi_card" "donut" "pie" "bar" "line" "area" "gauge" "sparkline" "table" "text"
  • kpi_card - KPI Card
  • donut - Donut Chart
  • pie - Pie Chart
  • bar - Bar Chart
  • line - Line Chart
  • area - Area Chart
  • gauge - Gauge
  • sparkline - Sparkline
  • table - Table
  • text - Text
time_range
string (TimeRangeEnum)
Enum: "last_hour" "last_24_hours" "last_7_days" "last_30_days" "last_90_days" "last_year" "all_time" "custom"
  • last_hour - Last Hour
  • last_24_hours - Last 24 Hours
  • last_7_days - Last 7 Days
  • last_30_days - Last 30 Days
  • last_90_days - Last 90 Days
  • last_year - Last Year
  • all_time - All Time
  • custom - Custom Range
aggregation
string (AggregationEnum)
Enum: "none" "avg" "sum" "min" "max" "count" "last"
  • none - None (Raw Data)
  • avg - Average
  • sum - Sum
  • min - Minimum
  • max - Maximum
  • count - Count
  • last - Last Value
show_target
boolean

Display target value line if defined on metric instance

show_legend
boolean (Show title and legend)

Display widget title bar and legend (for charts)

widget_config
any

Additional widget configuration. Format: {'color_scheme': 'default', 'threshold_colors': {...}, 'custom_options': {...}}

folder
string <uuid>
dashboard
string <uuid>
metric_instance
string or null <uuid>

For custom metrics: the metric instance to display

target_content_type
integer or null

For builtin metrics: the type of object (e.g., ComplianceAssessment)

Responses

Request samples

Content type
{
  • "target_model": "string",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "dashboard": "3433706f-318c-4403-80ab-a3125b1dbb42",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "target_content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "target_content_type_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "target_object_id": "9335a12d-0588-479c-8950-e154cce94188",
  • "metric_key": "string",
  • "title": "string",
  • "text_content": "string",
  • "position_x": 9223372036854776000,
  • "position_y": 9223372036854776000,
  • "width": 9223372036854776000,
  • "height": 9223372036854776000,
  • "chart_type": "kpi_card",
  • "time_range": "last_hour",
  • "aggregation": "none",
  • "show_target": true,
  • "show_legend": true,
  • "widget_config": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "dashboard": "3433706f-318c-4403-80ab-a3125b1dbb42",
  • "metric_instance": "60ce83f7-5b0b-4212-be73-89c6dbde529a",
  • "target_content_type": 0
}

metrology_dashboard_widgets_destroy

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard widget.

Responses

metrology_dashboard_widgets_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard widget.

Responses

metrology_dashboard_widgets_object_retrieve

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard widget.

Responses

metrology_dashboard_widgets_aggregation_retrieve

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

metrology_dashboard_widgets_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

metrology_dashboard_widgets_chart_type_retrieve

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

metrology_dashboard_widgets_time_range_retrieve

API endpoint that allows dashboard widgets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

dashboards

metrology_dashboards_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
filtering_labels
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

metrology_dashboards_create

API endpoint that allows dashboards to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string or null (Reference id) <= 100 characters
dashboard_definition
any

Global dashboard configuration. Format: {'layout': {'columns': 12, 'row_height': 100}, 'global_filters': {'time_range': 'last_30_days', 'refresh_interval': 300}}

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

metrology_dashboards_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "folder": "string",
  • "filtering_labels": [
    ],
  • "widget_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null
}

metrology_dashboards_update

API endpoint that allows dashboards to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string or null (Reference id) <= 100 characters
dashboard_definition
any

Global dashboard configuration. Format: {'layout': {'columns': 12, 'row_height': 100}, 'global_filters': {'time_range': 'last_30_days', 'refresh_interval': 300}}

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

metrology_dashboards_partial_update

API endpoint that allows dashboards to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string or null (Reference id) <= 100 characters
dashboard_definition
any

Global dashboard configuration. Format: {'layout': {'columns': 12, 'row_height': 100}, 'global_filters': {'time_range': 'last_30_days', 'refresh_interval': 300}}

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "dashboard_definition": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

metrology_dashboards_destroy

API endpoint that allows dashboards to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard.

Responses

metrology_dashboards_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard.

Responses

metrology_dashboards_object_retrieve

API endpoint that allows dashboards to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Dashboard.

Responses

metrology_dashboards_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

get_audits_metrics

get_audits_metrics_retrieve

API endpoint that returns the expensive audit metrics (progress avg + audits stats). Split from get_metrics to allow independent streaming.

Authorizations:
knoxApiToken

Responses

get_combined_assessments_status

get_combined_assessments_status_retrieve

API endpoint that returns combined assessment counts per status for RiskAssessment, ComplianceAssessment, and FindingsAssessment

Authorizations:
knoxApiToken

Responses

get_counters

get_counters_retrieve

API endpoint that returns the counters

Authorizations:
knoxApiToken

Responses

get_governance_calendar_data

get_governance_calendar_data_retrieve

API endpoint that returns governance activity calendar data Aggregates TaskNode due dates, AppliedControl ETAs, and RiskAcceptance expiry dates

Authorizations:
knoxApiToken

Responses

get_metrics

get_metrics_retrieve

API endpoint that returns the counters

Authorizations:
knoxApiToken

Responses

metric-definitions

metrology_metric_definitions_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
category
Array of strings
Items Enum: "qualitative" "quantitative"
  • qualitative - Qualitative (Level)
  • quantitative - Quantitative (Number)
filtering_labels
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

is_published
boolean
library
Array of strings <uuid> [ items <uuid > ]
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

provider
string
search
string

A search term.

unit
Array of strings <uuid> [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

metrology_metric_definitions_create

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
locale
string <= 100 characters
default_locale
boolean
category
string (CategoryD19Enum)
Enum: "qualitative" "quantitative"
  • qualitative - Qualitative (Level)
  • quantitative - Quantitative (Number)
choices_definition
any or null

For qualitative metrics: ordered list of options with translations. Format: [{'name': 'Low', 'description': '', 'translations': {'fr': {'name': 'Faible', 'description': ''}}}]

is_published
boolean (Published)
higher_is_better
boolean

If true, an increase in value is considered positive (e.g., compliance score). If false, a decrease is considered positive (e.g., number of vulnerabilities).

default_target
number or null <double>

Default target value for metric instances. Can be overridden at instance level.

folder
string <uuid>
library
string or null <uuid>
unit
string or null <uuid>

Unit of measurement (e.g., count, users, bytes, percentage, score, event_per_second)

filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "filtering_labels": [
    ]
}

metrology_metric_definitions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric definition.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "path": "string",
  • "folder": "string",
  • "library": "string",
  • "unit": "string",
  • "filtering_labels": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1
}

metrology_metric_definitions_update

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric definition.

Request Body schema:
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
locale
string <= 100 characters
default_locale
boolean
category
string (CategoryD19Enum)
Enum: "qualitative" "quantitative"
  • qualitative - Qualitative (Level)
  • quantitative - Quantitative (Number)
choices_definition
any or null

For qualitative metrics: ordered list of options with translations. Format: [{'name': 'Low', 'description': '', 'translations': {'fr': {'name': 'Faible', 'description': ''}}}]

is_published
boolean (Published)
higher_is_better
boolean

If true, an increase in value is considered positive (e.g., compliance score). If false, a decrease is considered positive (e.g., number of vulnerabilities).

default_target
number or null <double>

Default target value for metric instances. Can be overridden at instance level.

folder
string <uuid>
library
string or null <uuid>
unit
string or null <uuid>

Unit of measurement (e.g., count, users, bytes, percentage, score, event_per_second)

filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "filtering_labels": [
    ]
}

metrology_metric_definitions_partial_update

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric definition.

Request Body schema:
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
locale
string <= 100 characters
default_locale
boolean
category
string (CategoryD19Enum)
Enum: "qualitative" "quantitative"
  • qualitative - Qualitative (Level)
  • quantitative - Quantitative (Number)
choices_definition
any or null

For qualitative metrics: ordered list of options with translations. Format: [{'name': 'Low', 'description': '', 'translations': {'fr': {'name': 'Faible', 'description': ''}}}]

is_published
boolean (Published)
higher_is_better
boolean

If true, an increase in value is considered positive (e.g., compliance score). If false, a decrease is considered positive (e.g., number of vulnerabilities).

default_target
number or null <double>

Default target value for metric instances. Can be overridden at instance level.

folder
string <uuid>
library
string or null <uuid>
unit
string or null <uuid>

Unit of measurement (e.g., count, users, bytes, percentage, score, event_per_second)

filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "qualitative",
  • "choices_definition": null,
  • "is_published": true,
  • "higher_is_better": true,
  • "default_target": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "filtering_labels": [
    ]
}

metrology_metric_definitions_destroy

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric definition.

Responses

metrology_metric_definitions_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric definition.

Responses

metrology_metric_definitions_object_retrieve

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric definition.

Responses

metrology_metric_definitions_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

metrology_metric_definitions_category_retrieve

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken

Responses

metrology_metric_definitions_provider_retrieve

API endpoint that allows metric definitions to be viewed or edited.

Authorizations:
knoxApiToken

Responses

metric-instances

metrology_metric_instances_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
collection_frequency
Array of strings or null
Items Enum: "daily" "hourly" "monthly" "quarterly" "realtime" "weekly" "yearly"

Expected frequency for collecting metric samples

  • realtime - Real-time (continuous)
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • quarterly - Quarterly
  • yearly - Yearly
evidences
Array of strings <uuid> [ items <uuid > ]
filtering_labels
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

metric_definition
Array of strings <uuid> [ items <uuid > ]
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

organisation_objectives
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

status
Array of strings
Items Enum: "active" "deprecated" "draft" "stale"
  • draft - Draft
  • active - Active
  • stale - Stale
  • deprecated - Deprecated

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

metrology_metric_instances_create

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
organisation_objectives
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string or null (Reference id) <= 100 characters
status
string (MetricInstanceWriteStatusEnum)
Enum: "draft" "active" "stale" "deprecated"
  • draft - Draft
  • active - Active
  • stale - Stale
  • deprecated - Deprecated
target_value
number or null <double>

Target or optimal value for this metric instance

(CollectionFrequencyEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Expected frequency for collecting metric samples

  • realtime - Real-time (continuous)
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • quarterly - Quarterly
  • yearly - Yearly
folder
string <uuid>
metric_definition
required
string <uuid>
evidences
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "organisation_objectives": [
    ],
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "draft",
  • "target_value": 0.1,
  • "collection_frequency": "realtime",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "metric_definition": "9040ffd6-cdda-47ef-9d54-025dd778e24a",
  • "evidences": "703b2153-25a7-4cf6-a8e7-0e89c6175d25",
  • "filtering_labels": [
    ],
  • "owner": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisation_objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "draft",
  • "target_value": 0.1,
  • "collection_frequency": "realtime",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "metric_definition": "9040ffd6-cdda-47ef-9d54-025dd778e24a",
  • "evidences": "703b2153-25a7-4cf6-a8e7-0e89c6175d25",
  • "filtering_labels": [
    ],
  • "owner": [
    ]
}

metrology_metric_instances_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric instance.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "folder": "string",
  • "metric_definition": "string",
  • "owner": [
    ],
  • "organisation_objectives": [
    ],
  • "filtering_labels": [
    ],
  • "evidences": "string",
  • "status": "string",
  • "collection_frequency": "string",
  • "current_value": "string",
  • "raw_value": "string",
  • "unit": "string",
  • "last_refresh": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "target_value": 0.1
}

metrology_metric_instances_update

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric instance.

Request Body schema:
required
organisation_objectives
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string or null (Reference id) <= 100 characters
status
string (MetricInstanceWriteStatusEnum)
Enum: "draft" "active" "stale" "deprecated"
  • draft - Draft
  • active - Active
  • stale - Stale
  • deprecated - Deprecated
target_value
number or null <double>

Target or optimal value for this metric instance

(CollectionFrequencyEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Expected frequency for collecting metric samples

  • realtime - Real-time (continuous)
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • quarterly - Quarterly
  • yearly - Yearly
folder
string <uuid>
metric_definition
required
string <uuid>
evidences
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "organisation_objectives": [
    ],
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "draft",
  • "target_value": 0.1,
  • "collection_frequency": "realtime",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "metric_definition": "9040ffd6-cdda-47ef-9d54-025dd778e24a",
  • "evidences": "703b2153-25a7-4cf6-a8e7-0e89c6175d25",
  • "filtering_labels": [
    ],
  • "owner": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisation_objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "draft",
  • "target_value": 0.1,
  • "collection_frequency": "realtime",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "metric_definition": "9040ffd6-cdda-47ef-9d54-025dd778e24a",
  • "evidences": "703b2153-25a7-4cf6-a8e7-0e89c6175d25",
  • "filtering_labels": [
    ],
  • "owner": [
    ]
}

metrology_metric_instances_partial_update

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric instance.

Request Body schema:
organisation_objectives
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string or null (Reference id) <= 100 characters
status
string (MetricInstanceWriteStatusEnum)
Enum: "draft" "active" "stale" "deprecated"
  • draft - Draft
  • active - Active
  • stale - Stale
  • deprecated - Deprecated
target_value
number or null <double>

Target or optimal value for this metric instance

(CollectionFrequencyEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Expected frequency for collecting metric samples

  • realtime - Real-time (continuous)
  • hourly - Hourly
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • quarterly - Quarterly
  • yearly - Yearly
folder
string <uuid>
metric_definition
string <uuid>
evidences
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "organisation_objectives": [
    ],
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "draft",
  • "target_value": 0.1,
  • "collection_frequency": "realtime",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "metric_definition": "9040ffd6-cdda-47ef-9d54-025dd778e24a",
  • "evidences": "703b2153-25a7-4cf6-a8e7-0e89c6175d25",
  • "filtering_labels": [
    ],
  • "owner": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisation_objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "status": "draft",
  • "target_value": 0.1,
  • "collection_frequency": "realtime",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "metric_definition": "9040ffd6-cdda-47ef-9d54-025dd778e24a",
  • "evidences": "703b2153-25a7-4cf6-a8e7-0e89c6175d25",
  • "filtering_labels": [
    ],
  • "owner": [
    ]
}

metrology_metric_instances_destroy

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric instance.

Responses

metrology_metric_instances_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric instance.

Responses

metrology_metric_instances_object_retrieve

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Metric instance.

Responses

metrology_metric_instances_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

metrology_metric_instances_collection_frequency_retrieve

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken

Responses

metrology_metric_instances_status_retrieve

API endpoint that allows metric instances to be viewed or edited.

Authorizations:
knoxApiToken

Responses