Events REST API Guide

Publish events to Fiddler Platform

post

Publish events to Fiddler Platform

Authorizations
Body
model_idstring · uuidRequired
env_typestring · enumRequiredPossible values:
env_namestring | nullableOptional
sourceany ofRequired
or
Responses
200
Events uploaded
application/json
Responseall of
post
POST /v3/events HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "model_id": "123e4567-e89b-12d3-a456-426614174000",
  "env_type": "PRODUCTION",
  "env_name": "text",
  "source": {
    "type": "EVENTS",
    "events": [
      {}
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "source_type": "EVENTS",
    "event_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Delete events in Fiddler Platform

delete

Delete events in Fiddler Platform

Authorizations
Body
model_idstring · uuidRequired
event_idsstring[] | nullableOptional
update_metricsbooleanOptional
Responses
202
Events Deletion request received
application/json
Responseall of
delete
DELETE /v3/events HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "model_id": "123e4567-e89b-12d3-a456-426614174000",
  "time_range": {
    "start_time": "text",
    "end_time": "text"
  },
  "event_ids": [
    "text"
  ],
  "update_metrics": true
}
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Publish update events to Fiddler Platform

patch

Publish update events to Fiddler Platform

Authorizations
Body
model_idstring · uuidRequired
env_typestring · enumRequiredPossible values:
env_namestring | nullableOptional
sourceany ofRequired
or
Responses
200
Events uploaded
application/json
Responseall of
patch
PATCH /v3/events HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "model_id": "123e4567-e89b-12d3-a456-426614174000",
  "env_type": "PRODUCTION",
  "env_name": "text",
  "source": {
    "type": "EVENTS",
    "events": [
      {}
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "source_type": "EVENTS",
    "event_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Last updated

Was this helpful?