Skip to content

project.auditTrail.export.requested

Python model

ProjectAuditTrailExportRequestedEvent — from kili_events import ProjectAuditTrailExportRequestedEvent

Description

This event is raised when a user requests a JSON export of the project audit trail. It is processed by a Kili backend consumer that creates the user notification tracking the export, builds the JSON file, stores it on a bucket and updates the notification with the download URL.

Properties

event

  • Required
  • The name of the event.
  • Constant value: "project.auditTrail.export.requested"

project_id

  • Required
  • Type: string
  • Id of the project whose audit trail is exported.

user_id

  • Required
  • Type: string
  • Id of the user who requested the export and who receives the export notification.

organization_id

  • Required
  • Type: string
  • Id of the organization in which the project was created. It references the project author organization.

payload

  • Required
  • Type: object
  • The payload of the event, containing the export window and options.
  • Properties
    • from_date
      • Required
      • Type: string
      • Start of the export window, as an ISO 8601 datetime string.
    • to_date
      • Required
      • Type: string
      • End of the export window, as an ISO 8601 datetime string.
    • include_payload
      • Required
      • Type: boolean
      • When true, each exported row also contains the raw event payload.
    • categories
      • Type: array
      • Optional list of event names used to filter the exported events. Kept as plain strings so it can map to event categories once they are introduced.
        • Items
        • Type: string

event

  • Required
  • The name of the event.
  • Constant value: "project.auditTrail.export.requested"

projectId

  • Required
  • Type: string
  • Id of the project whose audit trail is exported.

userId

  • Required
  • Type: string
  • Id of the user who requested the export and who receives the export notification.

organizationId

  • Required
  • Type: string
  • Id of the organization in which the project was created. It references the project author organization.

payload

  • Required
  • Type: object
  • The payload of the event, containing the export window and options.
  • Properties
    • fromDate
      • Required
      • Type: string
      • Start of the export window, as an ISO 8601 datetime string.
    • toDate
      • Required
      • Type: string
      • End of the export window, as an ISO 8601 datetime string.
    • includePayload
      • Required
      • Type: boolean
      • When true, each exported row also contains the raw event payload.
    • categories
      • Type: array
      • Optional list of event names used to filter the exported events. Kept as plain strings so it can map to event categories once they are introduced.
        • Items
        • Type: string