👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

Events REST API Guide

PreviousServer Info REST API Guide NextAbout Client 3.x

Last updated 1 day ago

Was this helpful?

Publish events to Fiddler Platform

POST/v3/events

Authorization

Body

model_id*string (uuid)

env_type*enum

PRODUCTIONPRE_PRODUCTION

env_namenullable string

source*any of

Response

Events uploaded

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataany of

Request

const response = await fetch('/v3/events', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "model_id": "123e4567-e89b-12d3-a456-426614174000",
      "env_type": "PRODUCTION",
      "source": {
        "type": "EVENTS",
        "events": [
          {}
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "source_type": "EVENTS",
    "event_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Delete events in Fiddler Platform

DELETE/v3/events

Authorization

Body

model_id*string (uuid)

time_rangenullable object

event_idsnullable array of string

update_metricsboolean

Response

Events Deletion request received

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

const response = await fetch('/v3/events', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "model_id": "123e4567-e89b-12d3-a456-426614174000",
      "time_range": {},
      "event_ids": [
        null
      ]
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Publish update events to Fiddler Platform

PATCH/v3/events

Authorization

Body

model_id*string (uuid)

env_type*enum

PRODUCTIONPRE_PRODUCTION

env_namenullable string

source*any of

Response

Events uploaded

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataany of

Request

const response = await fetch('/v3/events', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "model_id": "123e4567-e89b-12d3-a456-426614174000",
      "env_type": "PRODUCTION",
      "source": {
        "type": "EVENTS",
        "events": [
          {}
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "source_type": "EVENTS",
    "event_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}