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 OrganizationDataCampaigns API

The OrganizationDataCampaigns API from Edge Impulse — 7 operation(s) for organizationdatacampaigns.

Edge Impulse OrganizationDataCampaigns 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 OrganizationDataCampaigns. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 7 paths, and defines 19 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.

12 operations 7 paths 19 schemas 2 DELETE4 GET6 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 OrganizationDataCampaigns 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 12

Across 7 paths, the API surfaces 12 operations — 2 DELETE, 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

OrganizationDataCampaigns 12
GET
/api/organizations/{organizationId}/campaign-dashboards
Get data campaign dashboards
getOrganizationDataCampaignDashboards 1 param → 200
POST
/api/organizations/{organizationId}/campaign-dashboards
Add data campaign dashboard
addOrganizationDataCampaignDashboard 1 param body → 200
GET
/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}
Get data campaign dashboard
getOrganizationDataCampaignDashboard 2 params → 200
POST
/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}
Update data campaign dashboard
updateOrganizationDataCampaignDashboard 2 params body → 200
DELETE
/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}
Delete data campaign dashboard
deleteOrganizationDataCampaignDashboard 2 params → 200
GET
/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns
Get data campaigns
getOrganizationDataCampaignsForDashboard 2 params → 200
POST
/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/screenshot
Upload a dashboard screenshot
uploadDashboardScreenshot 2 params body → 200
POST
/api/organizations/{organizationId}/campaigns
Add a data campaign
addOrganizationDataCampaign 1 param body → 200
GET
/api/organizations/{organizationId}/campaigns/{campaignId}
Get data campaign
getOrganizationDataCampaign 2 params → 200
POST
/api/organizations/{organizationId}/campaigns/{campaignId}
Update data campaign
updateOrganizationDataCampaign 2 params body → 200
DELETE
/api/organizations/{organizationId}/campaigns/{campaignId}
Delete data campaign
deleteOrganizationDataCampaign 2 params → 200
POST
/api/organizations/{organizationId}/campaigns/{campaignId}/diff
Get diff for data campaign
getOrganizationDataCampaignDiff 2 params body → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are AddOrganizationDataCampaignRequest (12 properties), DataCampaign (12 properties), UpdateOrganizationDataCampaignRequest (10 properties), DataCampaignDashboard (7 properties). Each schema is shown below with its type and property counts.

AddOrganizationDataCampaignDashboardRequest
object
4 properties 4 required
UploadImageRequest
object
1 property 1 required
UpdateOrganizationDataCampaignDashboardRequest
object
4 properties
GetOrganizationDataCampaignsResponse
DataCampaign
object
12 properties 11 required
AddOrganizationDataCampaignDashboardResponse
UpdateOrganizationDataCampaignRequest
object
10 properties
GetOrganizationDataCampaignDashboardResponse
OrganizationDataCampaignDiffRequest
object
1 property 1 required
DataCampaignQuery
object
3 properties 3 required
GenericApiResponse
object
2 properties 1 required
DataCampaignGraph
object
5 properties 5 required
OrganizationDataCampaignDiffResponse
DataCampaignDashboard
object
7 properties 6 required
AddOrganizationDataCampaignResponse
GetOrganizationDataCampaignDashboardsResponse
GetOrganizationDataCampaignResponse
DataCampaignLink
object
3 properties 3 required
AddOrganizationDataCampaignRequest
object
12 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-organizationdatacampaigns-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