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

Events REST API Guide

PreviousServer Info REST API Guide NextAbout Client 3.x

Last updated 1 month ago

Was this helpful?

Publish events to Fiddler Platform

post

/v3/events

Authorizations

Body

model_idstring · uuidrequired

env_typestring · enumrequired

Options: PRODUCTION, PRE_PRODUCTION

env_namestring | nullable

sourceany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/events' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "model_id": "123e4567-e89b-12d3-a456-426614174000",
    "env_type": "PRODUCTION",
    "env_name": "text",
    "source": {
      "type": "EVENTS",
      "events": [
        {}
      ]
    }
  }'

200

400

404

500

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

Events uploaded

Delete events in Fiddler Platform

delete

/v3/events

Authorizations

Body

model_idstring · uuidrequired

time_rangeobject | nullable

event_idsstring[] | nullable

update_metricsboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v3/events' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "model_id": "123e4567-e89b-12d3-a456-426614174000",
    "time_range": {
      "start_time": "text",
      "end_time": "text"
    },
    "event_ids": [
      "text"
    ],
    "update_metrics": true
  }'

202

400

404

500

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

Events Deletion request received

Publish update events to Fiddler Platform

patch

/v3/events

Authorizations

Body

model_idstring · uuidrequired

env_typestring · enumrequired

Options: PRODUCTION, PRE_PRODUCTION

env_namestring | nullable

sourceany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v3/events' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "model_id": "123e4567-e89b-12d3-a456-426614174000",
    "env_type": "PRODUCTION",
    "env_name": "text",
    "source": {
      "type": "EVENTS",
      "events": [
        {}
      ]
    }
  }'

200

400

404

500

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

Events uploaded

Publish events to Fiddler Platform

Show child attributes

Show child attributes

Delete events in Fiddler Platform

Show child attributes

Publish update events to Fiddler Platform

Show child attributes

Show child attributes