> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivolio.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server.

# List events

GET /events

Returns a paginated list of recorded events with filters, free-text
search, and column sorting, including each event's delivery results.

Reference: https://docs.pivolio.com/api-reference/pivolio/events/list-events

## Authentication

- `X-Workspace-Id` header (required) — API Key authentication via header

## Request

### Query parameters

- `minutes` (integer, optional, default: 1440) — Trailing window; 0 = all
- `event_name` (list of string, optional, nullable)
- `platform` (list of enum, optional, nullable)
  - Allowed values: `meta`, `google`, `tiktok`, `linkedin`, `snapchat`, `pinterest`, `microsoft`, `reddit`, `x`
- `status` (list of enum, optional, nullable)
  - Allowed values: `sent`, `skipped`, `retrying`, `failed`, `suppressed`
- `test_mode` (boolean, optional, nullable)
- `q` (string, optional, nullable) — Free-text search
- `person_id` (string, optional, nullable) — Only this customer's events
- `sort` (enum, optional) — Server-sortable columns for the events list.
  - Allowed values: `time`, `event`, `source`
- `order` (enum, optional)
  - Allowed values: `asc`, `desc`
- `limit` (integer, optional, default: 50)
- `offset` (integer, optional, default: 0)

## Response

### 200

Successful Response

- `items` (list of EventListItem, required)
- `total` (integer, required)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (string, required)
- `code` (string, required)
- `errors` (list of FieldError, optional, nullable)

## Types

### EventListItem

A row in the events table — event facts + resolved person traits + the per-platform delivery outcomes.

- `event_id` (string, required)
- `event_name` (string, required)
- `event_time` (string, required)
- `anonymous_id` (string, required)
- `user_id` (string, required)
- `person_id` (string, required)
- `page_url` (string, required)
- `utm_source` (string, required)
- `utm_medium` (string, required)
- `channel` (string, required)
- `device_type` (string, required)
- `os` (string, required)
- `browser` (string, required)
- `country` (string, required)
- `revenue_cents` (integer, required)
- `currency` (string, required)
- `order_id` (string, required)
- `revenue_usd_cents` (integer, required)
- `test_mode` (boolean, required)
- `email` (string, optional, nullable)
- `phone` (string, optional, nullable)
- `first_name` (string, optional, nullable)
- `last_name` (string, optional, nullable)
- `deliveries` (list of EventDelivery, optional, default: [])

### FieldError

- `field` (string, required)
- `message` (string, required)

### EventDelivery

One platform's delivery outcome for an event.

- `platform` (enum, required) — Ad platforms. The subset with a destination adapter is dispatchable for CAPI (incl. Reddit); the rest (e.g. x) appear only as click sources.
  - Allowed values: `meta`, `google`, `tiktok`, `linkedin`, `snapchat`, `pinterest`, `microsoft`, `reddit`, `x`
- `status` (enum, required) — The outcome of one delivery attempt to one destination.
  - Allowed values: `sent`, `skipped`, `retrying`, `failed`, `suppressed`
- `status_code` (integer, optional, default: 0)
- `error_code` (string, optional, default: )
- `error_message` (string, optional, default: )
- `latency_ms` (integer, optional, default: 0)
- `attempt` (integer, optional, default: 1)

## Examples

**Response**

```json
{
  "items": [
    {
      "event_id": "evt_9f8b7c6d-1234-4a56-8e9f-0a1b2c3d4e5f",
      "event_name": "Purchase Completed",
      "event_time": "2024-06-10T15:22:30Z",
      "anonymous_id": "anon_7a8b9c0d1e2f3g4h5i6j",
      "user_id": "user_1234567890abcdef",
      "person_id": "person_abcdef1234567890",
      "page_url": "https://www.example.com/checkout/confirmation",
      "utm_source": "newsletter",
      "utm_medium": "email",
      "channel": "ecommerce",
      "device_type": "mobile",
      "os": "iOS 16.4",
      "browser": "Safari",
      "country": "US",
      "revenue_cents": 4999,
      "currency": "USD",
      "order_id": "order_20240610_987654321",
      "test_mode": false,
      "email": "jane.doe@example.com",
      "phone": "+14155552671",
      "first_name": "Jane",
      "last_name": "Doe",
      "deliveries": [
        {
          "platform": "meta",
          "status": "sent",
          "status_code": 200,
          "error_code": "",
          "error_message": "",
          "latency_ms": 120,
          "attempt": 1
        },
        {
          "platform": "google",
          "status": "retrying",
          "status_code": 503,
          "error_code": "SERVICE_UNAVAILABLE",
          "error_message": "Temporary server error, will retry",
          "latency_ms": 300,
          "attempt": 2
        }
      ]
    }
  ],
  "total": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/events"

headers = {"X-Workspace-Id": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/events';
const options = {method: 'GET', headers: {'X-Workspace-Id': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Workspace-Id", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/events")
  .header("X-Workspace-Id", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/events', [
  'headers' => [
    'X-Workspace-Id' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/events");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Workspace-Id", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Workspace-Id": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/events")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```