Class AnalyticsService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics

Hierarchy

CommonHttpService
- AnalyticsService

Index

Constructors

Methods

getViewers getViews initialize

Constructors

constructor

new AnalyticsService(getClientInstance): AnalyticsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns AnalyticsService
Inherited from CommonHttpService.constructor

Methods

getViewers

getViewers(params): Promise<{
    count?: number;
    id?: number;
} & {
    [key: string]: unknown;
}>
Get the total number of distinct viewers a piece of content has.
Parameters
- params: {
  contentId: string;
  fromDate?: string;
  }
  - contentId: string
    The ID of the content to get the viewers for.
  - OptionalfromDate?: string
    The number of views for the content since the date.
    Example
    2021-03-21T00:00:00.000Z
Returns Promise<{
    count?: number;
    id?: number;
} & {
    [key: string]: unknown;
}>
Returns the total number of distinct viewers for the content.

Path
GET /wiki/rest/api/analytics/content/{contentId}/viewers @scopes-current read:confluence-content.summary @scopes-beta read:analytics.content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-viewers-get

getViews

getViews(params): Promise<{
    count?: number;
    id?: number;
} & {
    [key: string]: unknown;
}>
Get the total number of views a piece of content has.
Parameters
- params: {
  contentId: string;
  fromDate?: string;
  }
  - contentId: string
    The ID of the content to get the views for.
  - OptionalfromDate?: string
    The number of views for the content since the date.
    Example
    2021-03-21T00:00:00.000Z
Returns Promise<{
    count?: number;
    id?: number;
} & {
    [key: string]: unknown;
}>
Returns the total number of views for the content.

Path
GET /wiki/rest/api/analytics/content/{contentId}/views @scopes-current read:confluence-content.summary @scopes-beta read:analytics.content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-views-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize