Skip to main content

Get Campaigns

GET 
/campaign

Get all campaigns created in past

Request​

Query Parameters

    page integer

    Page number (default is 0)

    size integer

    Number of items per page (default is 20)

    sort string

    Sort by field (default is created,ASC)

    Example: completed,DESC
    from date

    Filter by created at date

    Example: 2024-05-01T00:00:00
    to date

    Filter by created at date

    Example: 2024-09-01T00:00:00
    scheduled-from date

    Filter by scheduled date

    Example: 2024-05-01T00:00:00
    scheduled-to date

    Filter by scheduled date

    Example: 2024-09-01T00:00:00

Responses​

successful operation

Schema
    campaigns object
    content object[]

    List of entities for the current page

  • Array [
    • id uuid
    status string
    contentSourceUrl string
    campaign objectrequired
    name stringrequired
    subject stringrequired
    previewText string
    senderId uuidrequired
    template objectrequired
    html stringrequired
    contactIds string[]
    schedule object
    dateTime string
    days string[]
    time string
    delivered int64
    requests int64
    sent int64
    open int64
    totalOpen int64
    clicked int64
    totalClicked int64
    unsubscribed int64
    bounced int64
    openProgress int64
    totalOpenProgress double
    totalClickedProgress double
    unsubscribedProgress double
    deliveredProgress double
    bouncedProgress double
    clickedProgress double
  • ]
    • totalPages integer
    last boolean
    totalElements boolean
    sort object
    sorted boolean
    unsorted boolean
    empty boolean
    first boolean
    numberOfElements integer
    size integer
    number integer
    empty boolean
Loading...