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

Edge Impulse Metrics API

The Metrics API from Edge Impulse — 3 operation(s) for metrics.

Edge Impulse Metrics API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

3 operations 3 paths 4 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse Metrics API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 3

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

Metrics 3
GET
/api-metrics
Get public metrics
getPublicMetrics → 200
POST
/api-metrics/website/pageviews
Log website pageview
logWebsitePageview body → 200
POST
/api-metrics/events
Log analytics event
logAnalyticsEvent body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are LogWebsitePageviewRequest (3 properties), LogAnalyticsEventRequest (3 properties), GenericApiResponse (2 properties). Each schema is shown below with its type and property counts.

GetPublicMetricsResponse
GenericApiResponse
object
2 properties 1 required
LogAnalyticsEventRequest
object
3 properties 2 required
LogWebsitePageviewRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-metrics-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API