Get Report Events

GET 
/api/v1/reports/:report_id/events

Get all historical events for a report.

Request

Path Parameters

report_id uuidrequired

Query Parameters

last_sequence any
project_id any
organization_id any

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id uuidrequired

The id of the event

report_id uuidrequired

The id of the report

event_type Event Type (string)required

The type of the event

event_data

object

required

The data for the event

anyOf

ProgressEvent

Event for tracking progress of operations in workflows.

timestamp date-time

id uuid

The ID of the event

group_id uuidrequired

The ID of the group this event belongs to

type Type (string)

Default value: progress

variant ReportEventType (string)required

Possible values: [load_template, extract_plan, summarize, file_processing, generate_block, editing]

msg Msg (string)required

The message to display to the user

progress

object

Progress value between 0-1 if available

anyOf

MOD1

number

Possible values: <= 1

status Status (string)

Current status of the operation

Possible values: [pending, in_progress, completed, error]

Default value: pending

extra_detail

object

Any extra details to display to the user

anyOf

MOD1

object

ReportUpdateEvent

Event for updating the state of an report.

timestamp date-time

type Type (string)

Default value: report_block_update

msg Msg (string)

The message to display to the user

Default value: A block has been generated and is ready to be displayed

block

object

required

The block to update

idx Idx (integer)required

The index of the block

template Template (string)required

The content of the block

sources

object[]

The sources for the block

Array [

node

object

required

Provided for backward compatibility.

Note: we keep the field with the typo "seperator" to maintain backward compatibility for serialized objects.

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

Array [

number

]

extra_info object

A flat dictionary of metadata fields

excluded_embed_metadata_keys string[]

Metadata keys that are excluded from text for the embed model.

excluded_llm_metadata_keys string[]

Metadata keys that are excluded from text for the LLM.

relationships

object

A mapping of relationships to other node information.

property name*

object

anyOf

RelatedNodeInfo

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

MOD2

Array [

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

]

metadata_template Metadata Template (string)

Template for how metadata is formatted, with {key} and {value} placeholders.

Default value: {key}: {value}

metadata_separator Metadata Separator (string)

Separator between metadata fields when converting to string.

Default value:

text Text (string)

Text content of the node.

Default value:

mimetype Mimetype (string)

MIME type of the node content.

Default value: text/plain

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

metadata_seperator Metadata Seperator (string)

Separator between metadata fields when converting to string.

Default value:

text_template Text Template (string)

Template for how text is formatted, with {content} and {metadata_str} placeholders.

Default value: {metadata_str} {content}

class_name Class Name (string)

Default value: TextNode

score

object

anyOf

MOD1

number

class_name Class Name (string)

Default value: TextNodeWithScore

]

ReportStateEvent

Event for notifying when an report's state changes.

timestamp date-time

type Type (string)required

msg Msg (string)required

The message to display to the user

status ReportState (string)required

The new state of the report

Possible values: [pending, planning, waiting_approval, generating, completed, error]

timestamp date-timerequired

The timestamp for the event

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "report_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "event_type": "string",
    "event_data": {},
    "timestamp": "2024-07-29T15:51:28.071Z"
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}