Class AnalyticsApi

AnalyticsApi - object-oriented interface export AnalyticsApi

Hierarchy (view full)

BaseAPI
- AnalyticsApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiAnalyticsGet

Constructors

constructor

new AnalyticsApi(configuration?, basePath?, axios?): AnalyticsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AnalyticsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiAnalyticsGet

apiAnalyticsGet(minAmount?, maxAmount?, fromDate?, toDate?, statuses?, paymentTypes?, id?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, toIsAcceptedContact?, toCountryCode?, toExternalId?, toAvatar?, toId?, toCreated?, toShortId?, toObjectName?, limit?, page?, userId?, options?): Promise<AxiosResponse<DateTimeDecimalDataSeries, any>>
summary Retrieve a list of Payments summed by date
Parameters
- OptionalminAmount: number
  The minimum amount for filtering
- OptionalmaxAmount: number
  The maximum amount for filtering
- OptionalfromDate: string
  The starting date for filtering
- OptionaltoDate: string
  The end date for filtering
- Optionalstatuses: string[]
  A list of statuses for filtering
- OptionalpaymentTypes: string[]
  A list of payment types for filtering
- Optionalid: string
- OptionalshortId: string
- OptionaltoHandle: string
  The Mozaic handle for a contact
- OptionaltoEmail: string
  The email address of the contact
- OptionaltoPhone: string
  The fully qualified phone number of the contact
- OptionaltoName: string
  Loosely, the name of the contact. May be changed during registration
- OptionaltoPersonaId: string
  Specifies the persona associated with this contact record
- OptionaltoUserId: string
  Specifies the user associated with this contact record
- OptionaltoUserAccountId: string
  Specifies the user account id associated with this contact record
- OptionaltoIsAcceptedContact: boolean
  Specifies whether this contact is in network or out of network
- OptionaltoCountryCode: string
- OptionaltoExternalId: string
- OptionaltoAvatar: AvatarSize[]
  contact avatar
- OptionaltoId: string
- OptionaltoCreated: string
- OptionaltoShortId: string
- OptionaltoObjectName: string
  The name of this object
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DateTimeDecimalDataSeries, any>>
Throws
memberof AnalyticsApi
- Defined in src/api/api.ts:14610