---
updatedAt: 2026-04-21T21:34:05.000Z
agentTools:
  projectIndex: https://docs.oneschema.co/llms.txt
---

# List events for an embed

Returns a list of events that occurred for the specified embed session.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Importer Embeds",
    "version": "1",
    "contact": {
      "name": "OneSchema Support",
      "email": "support@oneschema.co"
    },
    "license": {
      "name": "proprietary",
      "url": "https://www.oneschema.co/terms-and-conditions"
    },
    "termsOfService": "https://www.oneschema.co/terms-and-conditions",
    "description": "An API for managing OneSchema Importer Embeds, including headless importer operations and embed events."
  },
  "tags": [
    {
      "name": "Importer Embed Events",
      "description": "Importer Embed Event operations"
    }
  ],
  "paths": {
    "/v1/embeds/{embed_id}/events": {
      "get": {
        "operationId": "get-embed-events",
        "summary": "List events for an embed",
        "description": "Returns a list of events that occurred for the specified embed session.",
        "parameters": [
          {
            "$ref": "#/components/parameters/EmbedIdPath"
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EmbedEventResource"
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/empty-response"
                }
              }
            }
          }
        },
        "tags": [
          "Importer Embed Events"
        ]
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "components": {
    "parameters": {
      "EmbedIdPath": {
        "name": "embed_id",
        "in": "path",
        "required": true,
        "description": "The id of the embed which contains the file.",
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "schemas": {
      "EmbedEventResource": {
        "type": "object",
        "required": [
          "uuid",
          "event_type",
          "trigger_type",
          "created_at",
          "has_snapshot",
          "id"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "description": "embed event uuid, eg \"uuid\":\"event-ddbb6677-460c-4eb5-b279-c7fd3f964dcf\""
          },
          "event_type": {
            "type": "string",
            "enum": [
              "embed_initialized",
              "embed_resumed",
              "embed_closed",
              "file_uploaded",
              "header_selected",
              "columns_mapped",
              "sheet_operation_performed",
              "import_submitted",
              "initial_validation_complete",
              "initial_validation_failed",
              "import_complete",
              "import_failed"
            ],
            "description": "eg \"event_type\":\"columns_mapped\""
          },
          "trigger_type": {
            "type": "string",
            "enum": [
              "user",
              "api",
              "automation"
            ],
            "description": "what kind of process triggered the event"
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/empty-response"
              }
            ],
            "description": "additional information, eg: \"data\":{\"validation_error_counts\":{\"item\":{\"PICKLIST\":1},\"some_column\":{\"MISSING\":1}}}"
          },
          "created_at": {
            "type": "number",
            "format": "double",
            "description": "embed event timestamp as epoch seconds, eg created_at\":1762463783.125189"
          },
          "has_snapshot": {
            "type": "boolean",
            "description": "whether snapshot data are available for this event, eg: \"has_snapshot\":true",
            "default": false
          },
          "id": {
            "type": "integer",
            "description": "embed event id, eg: \"id\":417836"
          }
        }
      },
      "empty-response": {
        "type": "object",
        "properties": {}
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oneschema.co",
      "description": "Production server (hosted in the US)",
      "variables": {}
    },
    {
      "url": "https://api.eu.oneschema.co",
      "description": "Production server (hosted in the EU)",
      "variables": {}
    },
    {
      "url": "https://api.ca.oneschema.co",
      "description": "Production server (hosted in Canada)",
      "variables": {}
    },
    {
      "url": "https://api.au.oneschema.co",
      "description": "Production server (hosted in Australia)",
      "variables": {}
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```