Skip to main content

List custom events for entity

GET 

/api/v1/catalog/:tag/custom-events

List custom events for entity

Request

Path Parameters

    tag stringrequired

    The entity tag (x-cortex-tag) that identifies the entity.

Query Parameters

    type string
    timestamp date-time
    pageSize int32

    Number of results to return per page. (Note: If no "pageSize" value is provided, the endpoint will attempt to return all custom events.)

    page int32

    Default value: 0

    Page number to return, 0-indexed.

Responses

Successfully retrieved custom events

Schema

    events

    object[]

    required

  • Array [

  • customData

    object

    Optional property to store additional data

    property name* object

    Optional property to store additional data

    description string

    Optional description of custom event

    timestamp date-timerequired

    Time when event occurred

    title stringrequired

    Name for custom event

    type stringrequired

    Type of custom event

    url string

    Optional URL associated with custom event

    uuid uuidrequired

    Automatically generated identifier

  • ]

  • page int32required

    Current page number, 0-indexed

    total int32required

    Total number of results

    totalPages int32required

    Total number of pages

Loading...