Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Calyptia metric API

The metric API from Calyptia — 17 operation(s) for metric.

Calyptia metric API is one of 41 APIs that Calyptia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include metric. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 17 paths, and defines 20 schemas. It is described by OpenAPI 3.0.4, at version 1.0.

Requests are made against 4 base URLs: https://cloud-api.calyptia.com, https://cloud-api-dev.calyptia.com, https://cloud-api-staging.calyptia.com, http://localhost:{port}.

17 operations 17 paths 20 schemas 17 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.0
Base URL
https://cloud-api.calyptia.com
Authentication
HTTP Bearer, API Key, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Calyptia metric API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (user). An API key is passed in the header as X-Project-Token (project). It supports OAuth 2.0 (auth0) using the clientCredentials and authorizationCode flows.

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 17 GET. Each is listed below with its method, path, parameters, and response codes.

metric 17
GET
/v1/projects/{projectID}/metricsdeprecated
Project metrics
projectMetrics 3 params → 200
GET
/v1/agents/{agentID}/metricsdeprecated
Agent metrics
agentMetricsV1 3 params → 200
GET
/v1/pipeline_metrics/{pipelineID}deprecated
Pipeline metrics
pipelineMetricsV1 3 params → 200
GET
/v1/aggregator_metrics/{aggregatorID}deprecated
Core instance metrics
aggregatorMetrics 3 params → 200
GET
/v1/aggregators/{aggregatorID}/pipelines_metricsdeprecated
Core instance pipelines metrics (bulk)
aggregatorPipelinesMetrics 4 params → 200
GET
/v2/core_instances/{coreInstanceID}/metrics
Core instance metrics
coreInstanceMetrics 2 params → 200
GET
/v2/core_instances/{coreInstanceID}/metrics_by_plugin
Core instance metrics by plugin.
coreInstanceMetricsByPlugin 2 params → 200
GET
/v2/core_instances/{coreInstanceID}/metrics_over_time
Core instance metrics over time
coreInstanceMetricsOverTime 3 params → 200
GET
/v2/core_instances/{coreInstanceID}/metrics_over_time_by_plugin
Core instance metrics over time organized by plugin
coreInstanceMetricsOverTimeByPlugin 3 params → 200
GET
/v2/pipelines/{pipelineID}/metrics
Pipeline metrics
pipelineMetrics 2 params → 200
GET
/v2/pipelines/{pipelineID}/metrics_by_plugin
Pipeline metrics by plugin.
pipelineMetricsByPlugin 2 params → 200
GET
/v2/pipelines/{pipelineID}/metrics_over_time
Pipeline metrics over time
pipelineMetricsOverTime 3 params → 200
GET
/v2/pipelines/{pipelineID}/metrics_over_time_by_plugin
Pipeline metrics over time organized by plugin
pipelineMetricsOverTimeByPlugin 3 params → 200
GET
/v2/agents/{agentID}/metrics
Agent metrics
agentMetrics 2 params → 200
GET
/v2/agents/{agentID}/metrics_by_plugin
Agent metrics by plugin.
agentMetricsByPlugin 2 params → 200
GET
/v2/agents/{agentID}/metrics_over_time
Agent metrics over time
agentMetricsOverTime 3 params → 200
GET
/v2/agents/{agentID}/metrics_over_time_by_plugin
Agent metrics over time organized by plugin
agentMetricsOverTimeByPlugin 3 params → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are OutputMetrics (8 properties), MetricsOverTimeOutput (8 properties), FilterMetrics (5 properties), MetricsOverTimeFilter (5 properties). Each schema is shown below with its type and property counts.

FilterMetrics
object
5 properties
Metrics
object
Metrics model.
1 property 1 required
AggregatorMetrics
object
Agent metrics model.
1 property 1 required
MetricsOverTimeByPluginOutput
object
2 properties 2 required
MetricsSummary
object
3 properties
MetricsOverTimeByPluginInput
object
2 properties 2 required
ProjectMetrics
object
Project metrics model.
2 properties 2 required
MetricsOverTimeByPlugin
object
3 properties 3 required
InputMetrics
object
2 properties
AgentMetrics
object
Agent metrics model.
1 property 1 required
AggregatorPipelinesMetrics
object
Map of metrics/error for each pipeline ID.
MetricsByPlugin
object
3 properties
MetricFields
object
Metric fields model.
2 properties 2 required
MetricsOverTimeOutput
object
8 properties 8 required
OutputMetrics
object
8 properties
MetricsOvertime
object
3 properties 3 required
MetricsOverTimeInput
object
2 properties 2 required
MetricOverTime
object
2 properties 2 required
MetricsOverTimeByPluginFilter
object
2 properties 2 required
MetricsOverTimeFilter
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-metric-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

Calyptia agent API
Calyptia agent_config API
Calyptia agent_error API
Calyptia aggregator API
Calyptia audit_log API
Calyptia aws_marketplace API
Calyptia cluster_object API
Calyptia cluster_object_regex API
Calyptia config_section API
Calyptia config_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API