Add a data campaign

Add a data campaign

Add a new data campaign to a data campaign dashboard

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns

Path parameters

organizationId*integer

Organization ID

Body

application/json

idinteger

dataCampaignDashboardId*integer

createdstring (date-time)

name*string

description*string

coordinatorUids*array of integer

List of user IDs that coordinate this campaign

logostring

queries*array of DataCampaignQuery (object)

links*array of DataCampaignLink (object)

datasets*array of string

pipelineIds*array of integer

projectIds*array of integer

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

dataCampaignId*integer

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text",
      "coordinatorUids": [],
      "queries": [
        {
          "name": "text",
          "dataset": "text",
          "query": "text"
        }
      ],
      "links": [
        {
          "icon": "text",
          "name": "text",
          "link": "text"
        }
      ],
      "datasets": [
        "text"
      ],
      "pipelineIds": [],
      "projectIds": []
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}