Class HootSuiteGetAnalyticsAction

Protected_companyIntegration

Protected_integration

ProtectedapiBaseUrl

• get apiBaseUrl(): string

  Get the API base URL for the platform

  Returns string

ProtectedaxiosInstance

• get axiosInstance(): AxiosInstance

  Get or create axios instance with interceptors

  Returns AxiosInstance

ProtectedcommonSocialParams

• get commonSocialParams(): ActionParam[]

  Common parameters for all social media actions

  Returns ActionParam[]

ProtectedoauthParams

• get oauthParams(): ActionParam[]

  OAuth-specific parameters that all OAuth actions should include

  Returns ActionParam[]

ProtectedplatformName

• get platformName(): string

  Get the platform name (e.g., 'Twitter', 'LinkedIn')

  Returns string

ProtectedbuildHeaders

• buildHeaders(additionalHeaders?: Record<string, string>): Record<string, string>

  Build common API headers including authentication

  Parameters

  • OptionaladditionalHeaders: Record<string, string>

  Returns Record<string, string>

ProtectedformatDate

• formatDate(date: string | Date): string

  Format date for API requests (ISO 8601)

  Parameters

  • date: string | Date

  Returns string

ProtectedformatHootSuiteDate

• formatHootSuiteDate(date: string | Date): string

  Format date for HootSuite API (ISO 8601)

  Parameters

  • date: string | Date

  Returns string

ProtectedgetAccessToken

• getAccessToken(): string

  Get the current access token

  Returns string

ProtectedgetCustomAttribute

• getCustomAttribute(attributeNumber: 1 | 2 | 3 | 4 | 5): string

  Get custom attributes from company integration

  Parameters

  • attributeNumber: 1 | 2 | 3 | 4 | 5

  Returns string

ProtectedgetParamValue

• getParamValue(params: ActionParam[], paramName: string): any

  Helper to get parameter value from params array

  Parameters

  • params: ActionParam[]
  • paramName: string

  Returns any

ProtectedgetProfileId

• getProfileId(params: any): string

  Get profile ID from parameters or default from integration

  Parameters

  • params: any

  Returns string

ProtectedgetRefreshToken

• getRefreshToken(): string

  Get the refresh token

  Returns string

ProtectedgetSocialProfiles

• getSocialProfiles(): Promise<HootSuiteProfile[]>

  Get social profiles for the authenticated user

  Returns Promise<HootSuiteProfile[]>

ProtectedhandleHootSuiteError

• handleHootSuiteError(error: AxiosError): never

  Handle HootSuite-specific errors

  Parameters

  • error: AxiosError

  Returns never

ProtectedhandleOAuthError

• handleOAuthError(error: any): ActionResultSimple

  Handle OAuth-specific errors

  Parameters

  • error: any

  Returns ActionResultSimple

ProtectedhandleRateLimit

• handleRateLimit(retryAfter?: number): Promise<void>

  Handle rate limiting with exponential backoff

  Parameters

  • OptionalretryAfter: number

  Returns Promise<void>

ProtectedinitializeOAuth

• initializeOAuth(
      companyIntegrationId: string,
      params?: RunActionParams,
  ): Promise<boolean>

  Initialize OAuth connection by loading integration details.

  Parameters

  • companyIntegrationId: string

    the MJ Company Integration ID to load

  • Optionalparams: RunActionParams

    the running action's params; params.Provider is captured so all subsequent entity loads/saves bind to the per-request provider (multi-tenant correctness). When omitted, falls back to the global default Metadata provider.

  Returns Promise<boolean>

ProtectedisAuthError

• isAuthError(error: any): boolean

  Determine if an error is an authentication error. Can be overridden by subclasses for platform-specific error detection.

  Parameters

  • error: any

  Returns boolean

ProtectedisTokenExpired

• isTokenExpired(): boolean

  Check if the current token is expired

  Returns boolean

ProtectedlogApiRequest

• logApiRequest(method: string, url: string, data?: any): void

  Log API request for debugging

  Parameters

  • method: string
  • url: string
  • Optionaldata: any

  Returns void

ProtectedlogApiResponse

• logApiResponse(response: any): void

  Log API response for debugging

  Parameters

  • response: any

  Returns void

ProtectedmakeAuthenticatedRequest

• makeAuthenticatedRequest<T>(
      requestFn: (token: string) => Promise<T>,
      retryOnAuthFailure?: boolean,
  ): Promise<T>

  Make an authenticated API request with automatic retry on auth failure

  Type Parameters

  • T

  Parameters

  • requestFn: (token: string) => Promise<T>
  • OptionalretryOnAuthFailure: boolean

  Returns Promise<T>

ProtectedmakePaginatedRequest

• makePaginatedRequest<T>(
      endpoint: string,
      params?: Record<string, any>,
  ): Promise<T[]>

  Make a paginated request to HootSuite API

  Type Parameters

  • T

  Parameters

  • endpoint: string
  • params: Record<string, any> = {}

  Returns Promise<T[]>

ProtectednormalizeAnalytics

• normalizeAnalytics(platformData: any): SocialAnalytics

  Normalize platform-specific analytics to common format

  Parameters

  • platformData: any

  Returns SocialAnalytics

ProtectednormalizePost

• normalizePost(hootsuitePost: HootSuitePost): SocialPost

  Convert HootSuite post to common format

  Parameters

  • hootsuitePost: HootSuitePost

  Returns SocialPost

ProtectedparseDate

• parseDate(dateString: string): Date

  Parse date from API response

  Parameters

  • dateString: string

  Returns Date

ProtectedparseHootSuiteDate

• parseHootSuiteDate(dateString: string): Date

  Parse HootSuite date string

  Parameters

  • dateString: string

  Returns Date

ProtectedparseRateLimitHeaders

• parseRateLimitHeaders(
      headers: any,
  ): { limit: number; remaining: number; reset: Date }

  Parse rate limit headers from API response

  Parameters

  • headers: any

  Returns { limit: number; remaining: number; reset: Date }

ProtectedrefreshAccessToken

• refreshAccessToken(): Promise<void>

  Refresh the access token using the refresh token

  Returns Promise<void>

ProtectedsearchPosts

• searchPosts(params: SearchParams): Promise<SocialPost[]>

  Search for posts - implemented in search action

  Parameters

  • params: SearchParams

  Returns Promise<SocialPost[]>

ProtectedsetCustomAttribute

• setCustomAttribute(
      attributeNumber: 1 | 2 | 3 | 4 | 5,
      value: string,
  ): Promise<void>

  Set custom attributes in company integration

  Parameters

  • attributeNumber: 1 | 2 | 3 | 4 | 5
  • value: string

  Returns Promise<void>

ProtectedupdateStoredTokens

• updateStoredTokens(
      accessToken: string,
      refreshToken?: string,
      expiresIn?: number,
  ): Promise<void>

  Update stored tokens after refresh

  Parameters

  • accessToken: string
  • OptionalrefreshToken: string
  • OptionalexpiresIn: number

  Returns Promise<void>

ProtecteduploadMedia

• uploadMedia(files: MediaFile[]): Promise<string[]>

  Upload media files to the platform

  Parameters

  • files: MediaFile[]

  Returns Promise<string[]>

ProtecteduploadSingleMedia

• uploadSingleMedia(file: MediaFile): Promise<string>

  Upload media to HootSuite

  Parameters

  • file: MediaFile

  Returns Promise<string>

ProtectedvalidateMediaFile

• validateMediaFile(file: MediaFile): void

  Validate media file meets platform requirements

  Parameters

  • file: MediaFile

  Returns void