Get Company Metric Values

Get all metric values recorded for a specific company.

GET /external/v1/external/v1/customers/companies/{company_id}/metrics

Request

Parameters

Name

Type

Description

Location

Required

company_id

string

Company ID (UUID) to retrieve metrics for.

Path

Yes

Example Request URL:

/external/v1/external/v1/customers/companies/COMP-XYZ-789/metrics

Responses

Successful Response (200) (application/json)

Returns an array of metric value objects for the specified company.

Field

Type

Description

id

integer

The internal database ID of the metric entry.

company_id

integer

The ID of the company (as an integer).

metric_id

integer

The internal ID of the metric type.

metric_name

string

The human-readable name of the metric (e.g., 'Monthly Users').

data_type

string

The data type of the stored value (e.g., STRING, NUMBER).

value

string

The recorded value of the metric.

time_created

string (datetime)

Creation timestamp of the metric entry.

time_updated

string (datetime)

Last update timestamp of the metric entry.

Example Response Body (200):

JSON

Validation Error (422) (application/json)

Last updated