Class: InsightApiClient
services/insight.InsightApiClient
Contains all the endpoints needed to manage insights.
Constructors
constructor
• new InsightApiClient(): InsightApiClient
Returns
Methods
getBestContributionInsight
▸ getBestContributionInsight(params?, config?): Promise<SCPaginatedResponse<SCContributionInsightType>>
This endpoint retrieves the best contribution insights list.
Parameters
| Name | Type |
|---|---|
params? | InsightContributionParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCContributionInsightType>>
Defined in
getBestEmbedInsight
▸ getBestEmbedInsight(params?, config?): Promise<SCPaginatedResponse<SCEmbedInsightType>>
This endpoint retrieves the best embed insights list. The operations of this endpoint is quite complex and returns different result structures based on the parameters passed. For example, pagination (and therefore the use of the offset parameter) is guaranteed only if the metadata and group_by parameter are not passed. If you are passing metadata you MUST pass also group_by. If you pass group_by the result will be not paginated and will contain only user defined custom embeds (not among these: 'sc_vimeo', 'sc_link', 'sc_shared_object').
Parameters
| Name | Type |
|---|---|
params? | InsightEmbedParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCEmbedInsightType>>
Defined in
getBestUsersInsight
▸ getBestUsersInsight(params?, config?): Promise<SCPaginatedResponse<SCUsersInsightType>>
This endpoint retrieves the best users insights list.
Parameters
| Name | Type |
|---|---|
params? | InsightUserParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUsersInsightType>>
Defined in
getContributionsInsightCounters
▸ getContributionsInsightCounters(id, config?): Promise<SCContributionInsightCountersType>
This endpoint retrieves a specific contribution's insight counters.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCContributionInsightCountersType>
Defined in
getEmbedsInsightCounters
▸ getEmbedsInsightCounters(type, id, config?): Promise<SCEmbedInsightCountersType>
This endpoint retrieves a specific embed's insight counters.
Parameters
| Name | Type |
|---|---|
type | string |
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCEmbedInsightCountersType>
Defined in
getUsersInsightCounters
▸ getUsersInsightCounters(id, config?): Promise<SCUsersInsightCountersType>
This endpoint retrieves a specific user's insight counters.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUsersInsightCountersType>