Skip to content

Back to Section navigation

Loading search...

Back to Site navigation

Company

Accessibility Statement
About Us
Careers
Leadership
Newsroom
Legal
Security Issue?
Privacy Policy

Partners

Partner Program
Become a Partner
Find a Partner
Partner Certification
Partner Helpdesk

Support

Product Accessibility
Product Documentation
Training & Certifications

53 State Street, 10th Floor
Boston, MA 02109
United States
Phone: 888-922-7842

Open product launcher

Open user menu

Acquia DAM Developer SDK docs | Acquia Product Documentation

Acquia DAM

Acquia DAM Developer SDK docs

No results found.

global

Components

Components/classes

SearchConnectorApi

Components/interfaces

AddDeliverableParams

AddDeliverableResult

AddMetadataValueParams

AddRemoveAssetsParams

AnalyticsRequestParams

ApiRequestParams

AssetByFilename

AssetProperties

AssetPropertiesExpand

BaseCreateAssetParams

BaseUpdateMetadataFieldValue

BasicSearchParams

CategoryTreeResult

CleanAssetsResult

CloseDeliverableParams

CompleteChunkedUploadParams

CompleteChunkedUploadResult

ConversionProperties

CreateAssetResult

CreateAssetWithChunkedUpload

CreateAssetWithFileContent

CreateAssetWithUrl

CreateAssetsWebhookParams

CreateAssetsWebhookResult

CreateCategoryParams

CreateCollectionParams

CreateCollectionResult

CreateEditCategoryResult

CreateOrderParams

CreateOrderResult

CreateProductParams

CreateProductResult

CreateProjectParams

CreateProjectResult

CreateWorkflowWebhookParams

DateRangeFilter

DownloadAssetEvent

EditAssetsWebhookParams

FilePropertiesExpand

GetAssetsWebhookResult

GetContactResult

GetDeliverableParams

GetDeliverableResult

GetMetadataFieldValueResult

GetMetadataResult

GetOrderDetailsResult

GetProductResult

GetProjectParams

GetProjectResult

GetSearchConnectorResult

GetSecurityResult

GetWorkflowWebhookResult

GetZipStatusResult

IdentifyOrderById

IdentifyOrderBySeqNum

InstantSearchConnectorParams

IntendedUseProperties

ListAssetDownloadsResponse

ListAssetGroupsResult

ListAssetSharesResponse

ListAssetViewsResponse

ListAssetsWebhooksParams

ListAssetsWebhooksResult

ListAttributeVocabularyResult

ListAttributesParams

ListAttributesResult

ListCategoriesResult

ListChannelsParams

ListChannelsResult

ListCollectionsParams

ListCollectionsResult

ListConversionsForOrderParams

ListConversionsForOrderResult

ListDeliverablesParams

ListDeliverablesResult

ListFieldValuesResult

ListFileFormatsResult

ListIntegrationLinksResult

ListMetadataTypesResult

ListOrderProfileResult

ListProductCategoriesResult

ListProductTypesParams

ListProductTypesResult

ListProductsByChannelParams

ListProductsByChannelResult

ListProductsCategoryParams

ListVersionsResult

ListViewableMetadataFieldsParams

ListViewableMetadataFieldsResult

ListWorkflowWebhooksResult

MetadataInfoExpand

ProductCategory

ProductSearchFilter

RegisterIntegrationLinkResult

ScrollSearchParams

SearchAssetsResult

SearchProductsParams

SearchProductsResult

ShareAssetEvent

StartChunkedUploadResult

ThumbnailsExpand

UpdateAttributesParams

UpdateFeaturedImageParams

UpdateParentProductParams

UpdateProductCategoryParams

UpdateProductTypeParams

UploadChunkParams

UploadChunkResult

UploadProofParams

UploadProofResult

Components/type-aliases

AssetSearchExpand

AssetSearchFacet

AssetsWebhookPatch

CategoriesParams

CollectionsParams

CreateAssetParams

DeliverableExpand

EditCategoryParams

GetOrderDetailsParams

GetSupportingFilesResult

JsonArrayWithDate

JsonObjectWithDate

JsonPrimitiveWithDate

ListUploadProfilesResult

MetadataFieldType

ProductSearchFilterOperator

ProductSearchFilterType

ProductSearchSortOrder

ProductSearchSortType

RegisterIntegrationLinkParams

RenameAssetParams

SearchAssetsParams

SecurityPatchValues

UpdateMetadataFieldValueParams

UpdateMetadataParams

UpdateMetadataTypeParams

UpdateSecurityParams

UploadAlternatePreviewParams

classes

interfaces

AcquiaDAMParams

Developers
Typescript SDK

Documentation

acquia-dam-sdk

acquia-dam-sdk / Components / AnalyticsApi

Class: AnalyticsApi

Constructors

new AnalyticsApi()

new AnalyticsApi(client): AnalyticsApi

Create an instance of the AnalyticsApi class.

The Analytics endpoints provide information about asset usage from the Insights application. The API will return download, view, and share details for a single asset. Events may take up to 24 hours before appearing in analytics API results. Note: Three years of analytics data is available, starting from January 1, 2021 onward. The default date_range filter is from this date until today.

Parameters

client

Provide an instance of ApiClient.

Returns

See

https://docs.acquia.com/acquia-dam/api-v2#tag/Analytics

Defined in

src/apis/analytics/api.ts:22

Methods

listAssetDownloads()

listAssetDownloads(params): Promise<ListAssetDownloadsResponse>

Retrieve a list of Asset Download events

Parameters

params

AnalyticsRequestParams

Information about the request

Returns

Promise<ListAssetDownloadsResponse>

Promise containing the Download Asset events that meet the request criteria

See

https://docs.acquia.com/acquia-dam/api-v2#tag/Analytics/operation/listAssetDownloads

Defined in

src/apis/analytics/api.ts:32

listAssetShares()

listAssetShares(params): Promise<ListAssetSharesResponse>

Retrieve a list of Asset Share events

Parameters

params

AnalyticsRequestParams

Information about the request

Returns

Promise<ListAssetSharesResponse>

Promise containing the Share Asset events that meet the request criteria

See

https://docs.acquia.com/acquia-dam/api-v2#tag/Analytics/operation/listAssetShares

Defined in

src/apis/analytics/api.ts:49

listAssetViews()

listAssetViews(params): Promise<ListAssetViewsResponse>

Retrieve a list of View Asset events

Parameters

params

AnalyticsRequestParams

Information about the request

Returns

Promise<ListAssetViewsResponse>

Promise containing the View Asset events that meet the request criteria

See

https://docs.acquia.com/acquia-dam/api-v2#tag/Analytics/operation/listAssetViews

Defined in

src/apis/analytics/api.ts:66