For the complete documentation index, see llms.txt. This page is also available as Markdown.

event-reports

Manage event reports — async exports of integration event data that build in the background and are downloaded via a signed URL.

REST API: Event reports

celigo event-reports <subcommand> [args] [flags]

Supports all global flags.

Subcommands

Subcommand
Purpose

list

List all event reports.

get <id>

Get an event report by ID.

create

Create an event report from a JSON body (stdin, or --file).

signed-url <id>

Get the signed download URL for an event report.

cancel <id>

Cancel an in-progress event report.


celigo event-reports list

List all event reports in the account.

Signature

celigo event-reports list [flags]

Flags

Flag

Type

Default

Description

No command-specific flags. Uses global flags only.

Example

Corresponds to: GET /v1/eventreports (operationId: listEventReports)


celigo event-reports get

Get one event report by ID.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Event report ID.

Example

Corresponds to: GET /v1/eventreports/{_id} (operationId: getEventReportById)


celigo event-reports create

Create an event report. Reads the JSON body from stdin, or from a file with --file.

Signature

Flags

Flag
Type
Default
Description

-f, --file <path>

string

stdin

Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or from --file). See the POST /v1/eventreports schema for the full payload shape.

Example

Corresponds to: POST /v1/eventreports (operationId: createEventReport)


celigo event-reports signed-url

Get the signed download URL for a completed event report.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Event report ID.

Example

Corresponds to: GET /v1/eventreports/{_id}/signedurl (operationId: getEventReportSignedUrl)


celigo event-reports cancel

Cancel an in-progress event report.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Event report ID.

Flags

Flag
Type
Default
Description

-y, --yes

boolean

false

Skip confirmation.

Example

Corresponds to: PUT /v1/eventreports/{_id}/cancel (operationId: cancelEventReport)

Last updated

Was this helpful?