List Events Within a Tenant

Browsing events within a tenant is exposed through the /me/feed

API.

This guide explains how to use the tenant feed API perform a full export of all results.

Parameters

Parameter	Value	Justification
lite	false	Retrieve all event fields. This will result in larger response payloads.
order	asc	Retrieve results in ascending order so that we can resume fetching in the future.
sort_by	searchable	Sort results in the order that they have been added to Flare’s database.

Paging

The tenant feed endpoint uses parameters that match the Flare standard paging pattern

Fetching new results in future executions

It is possible to save the next in a database and use it to resume fetching new results in the future. However, it is important that future requests use the same parameters for everything else but next. Even the time filter.

import os
import time

from flareio import FlareApiClient


api_key: str | None = os.environ.get("FLARE_API_KEY")
if not api_key:
    raise Exception("Please provide an API key")

api_client = FlareApiClient(api_key=api_key)

last_from: str | None = None
fetched_pages: int = 0

for resp in api_client.scroll(
    method="GET",
    url="/firework/v2/me/feed",
    params={
        "lite": "false",
        "order": "asc",
        "sort_by": "searchable",
        "from": None,
    }
):
    # Rate limiting.
    time.sleep(1)

    resp_data: dict = resp.json()

    fetched_pages += 1
    num_results: int = len(resp_data["items"])
    print(f"Fetched page {fetched_pages} with {num_results} results...")

    # Save the last "next" value.
    last_from = resp_data.get("next") or last_from

Introduction

Base Concepts

SDK

Advanced

Guides (more coming soon)

List Events Within a Tenant

Parameters

Paging

Fetching new results in future executions

Introduction

Base Concepts

SDK

Advanced

Guides (more coming soon)

​Parameters

​Paging

​Fetching new results in future executions

Parameters

Paging

Fetching new results in future executions