LogoLogo
👨‍💻 API Reference📣 Release Notes📺 Request a Demo
  • Introduction to Fiddler
    • Monitor, Analyze, and Protect your ML Models and Gen AI Applications
  • Fiddler Doc Chatbot
  • First Steps
    • Getting Started With Fiddler Guardrails
    • Getting Started with LLM Monitoring
    • Getting Started with ML Model Observability
  • Tutorials & Quick Starts
    • LLM and GenAI
      • LLM Evaluation - Compare Outputs
      • LLM Monitoring - Simple
    • Fiddler Free Guardrails
      • Guardrails - Quick Start Guide
      • Guardrails - Faithfulness
      • Guardrails - Safety
      • Guardrails FAQ
    • ML Observability
      • ML Monitoring - Simple
      • ML Monitoring - NLP Inputs
      • ML Monitoring - Class Imbalance
      • ML Monitoring - Model Versions
      • ML Monitoring - Ranking
      • ML Monitoring - Regression
      • ML Monitoring - Feature Impact
      • ML Monitoring - CV Inputs
  • Glossary
    • Product Concepts
      • Baseline
      • Custom Metric
      • Data Drift
      • Embedding Visualization
      • Fiddler Guardrails
      • Fiddler Trust Service
      • LLM and GenAI Observability
      • Metric
      • Model Drift
      • Model Performance
      • ML Observability
      • Trust Score
  • Product Guide
    • LLM Application Monitoring & Protection
      • LLM-Based Metrics
      • Embedding Visualizations for LLM Monitoring and Analysis
      • Selecting Enrichments
      • Enrichments (Private Preview)
      • Guardrails for Proactive Application Protection
    • Optimize Your ML Models and LLMs with Fiddler's Comprehensive Monitoring
      • Alerts
      • Package-Based Alerts (Private Preview)
      • Class Imbalanced Data
      • Enhance ML and LLM Insights with Custom Metrics
      • Data Drift: Monitor Model Performance Changes with Fiddler's Insights
      • Ensuring Data Integrity in ML Models And LLMs
      • Embedding Visualization With UMAP
      • Fiddler Query Language
      • Model Versions
      • How to Effectively Use the Monitoring Chart UI
      • Performance Tracking
      • Model Segments: Analyze Cohorts for Performance Insights and Bias Detection
      • Statistics
      • Monitoring ML Model and LLM Traffic
      • Vector Monitoring
    • Enhance Model Insights with Fiddler's Slice and Explain
      • Events Table in RCA
      • Feature Analytics Creation
      • Metric Card Creation
      • Performance Charts Creation
      • Performance Charts Visualization
    • Master AI Monitoring: Create, Customize, and Compare Dashboards
      • Creating Dashboards
      • Dashboard Interactions
      • Dashboard Utilities
    • Adding and Editing Models in the UI
      • Model Editor UI
      • Model Schema Editing Guide
    • Fairness
    • Explainability
      • Model: Artifacts, Package, Surrogate
      • Global Explainability: Visualize Feature Impact and Importance in Fiddler
      • Point Explainability
      • Flexible Model Deployment
        • On Prem Manual Flexible Model Deployment XAI
  • Technical Reference
    • Python Client API Reference
    • Python Client Guides
      • Installation and Setup
      • Model Onboarding
        • Create a Project and Onboard a Model for Observation
        • Model Task Types
        • Customizing your Model Schema
        • Specifying Custom Missing Value Representations
      • Publishing Inference Data
        • Creating a Baseline Dataset
        • Publishing Batches Of Events
        • Publishing Ranking Events
        • Streaming Live Events
        • Updating Already Published Events
        • Deleting Events From Fiddler
      • Creating and Managing Alerts
      • Explainability Examples
        • Adding a Surrogate Model
        • Uploading Model Artifacts
        • Updating Model Artifacts
        • ML Framework Examples
          • Scikit Learn
          • Tensorflow HDF5
          • Tensorflow Savedmodel
          • Xgboost
        • Model Task Examples
          • Binary Classification
          • Multiclass Classification
          • Regression
          • Uploading A Ranking Model Artifact
    • Integrations
      • Data Pipeline Integrations
        • Airflow Integration
        • BigQuery Integration
        • Integration With S3
        • Kafka Integration
        • Sagemaker Integration
        • Snowflake Integration
      • ML Platform Integrations
        • Integrate Fiddler with Databricks for Model Monitoring and Explainability
        • Datadog Integration
        • ML Flow Integration
      • Alerting Integrations
        • PagerDuty Integration
    • Comprehensive REST API Reference
      • Projects REST API Guide
      • Model REST API Guide
      • File Upload REST API Guide
      • Custom Metrics REST API Guide
      • Segments REST API Guide
      • Baselines REST API Guide
      • Jobs REST API Guide
      • Alert Rules REST API Guide
      • Environments REST API Guide
      • Explainability REST API Guide
      • Server Info REST API Guide
      • Events REST API Guide
      • Fiddler Trust Service REST API Guide
    • Fiddler Free Guardrails Documentation
  • Configuration Guide
    • Authentication & Authorization
      • Adding Users
      • Overview of Role-Based Access Control
      • Email Authentication
      • Okta Integration
      • SSO with Azure AD
      • Ping Identity SAML SSO Integration
      • Mapping LDAP Groups & Users to Fiddler Teams
    • Application Settings
    • Supported Browsers
  • History
    • Release Notes
    • Python Client History
    • Compatibility Matrix
    • Product Maturity Definitions
Powered by GitBook

© 2024 Fiddler Labs, Inc.

On this page

Was this helpful?

  1. Technical Reference
  2. Comprehensive REST API Reference

Events REST API Guide

PreviousServer Info REST API GuideNextFiddler Trust Service REST API Guide

Last updated 3 months ago

Was this helpful?

  • POSTPublish events to Fiddler Platform
  • DELETEDelete events in Fiddler Platform
  • PATCHPublish update events to Fiddler Platform

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
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
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": "2.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
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
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": "2.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
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
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": "2.0",
  "kind": "NORMAL",
  "data": {
    "source_type": "EVENTS",
    "event_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}