List Events Within a Tenant

Browsing events within a tenant is exposed through the List Tenant Events

API.

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

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 exactly the same parameters for everything else but next.

Getting the full data of results

For performance reasons, feed results only contain the bear minimum. To get the full data, an API call must be made per result to the Retrieve Event

endpoint.

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="POST",
    url="/firework/v4/events/tenant/_search",
    json={
        "from": last_from,
    }
):
    # 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

    # Get the full data
    for item in resp_data["items"]:
        # Rate limiting.
        time.sleep(1)

        item_uid: str = item["metadata"]["uid"]
        response = api_client.get(f"/firework/v2/activities/{item_uid}")
        full_data = response.json()
        print(f"Here is the full data of the event: {full_data}")

List events for a single identifier

If you’re looking to export the events of a single identifier, refer to the List Identifier Events

endpoint.

# (incomplete example)

# ID of the identifier for which we want to list the events.
identifier_id: int = 12345

for resp in api_client.scroll(
    method="POST",
    url=f"/firework/v4/events/identifiers/{identifier_id}/_search",
    json={
        "from": last_from,
    }
):
    ...

List events for an identifier group

If you’re looking to export the events of an entire identifier group, refer to the List Identifier Group’s Events

endpoint.

# (incomplete example)

# ID of the identifier group for which we want to list the events.
identifier_group_id: int = 12345

for resp in api_client.scroll(
    method="POST",
    url=f"/firework/v4/events/identifier_groups/{identifier_group_id}/_search",
    json={
        "from": last_from,
    }
):
    ...

Introduction

Base Concepts

SDK

Advanced

Guides

List Events Within a Tenant

Paging

Fetching new results in future executions

Getting the full data of results

List events for a single identifier

List events for an identifier group

Introduction

Base Concepts

SDK

Advanced

Guides

​Paging

​Fetching new results in future executions

​Getting the full data of results

​List events for a single identifier

​List events for an identifier group

Paging

Fetching new results in future executions

Getting the full data of results

List events for a single identifier

List events for an identifier group