Documentation

Mistake on this page? Email us

CampaignStatistics repository

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

events

  • events

    Parameters

    • campaignId: string

      The campaign ID

    • id: string

      The summary status. For example, fail

    • Optional options: ListOptions

      options

    Returns Paginator<CampaignStatisticsEvents, ListOptions>

list

  • list

    Parameters

    • campaignId: string

      The campaign ID

    • Optional options: ListOptions

      options

    Returns Paginator<CampaignStatistics, ListOptions>

read

  • read

    Parameters

    • campaignId: string

      ID of the associated campaign.

    • id: string

      ID of the event type description

    Returns Promise<CampaignStatistics>