开发者社区> 镜像站> NPM> @adobe/aio-lib-analytics
@adobe/aio-lib-analytics
Adobe Analytics SDK
Last updated 7 months ago by purplecabbage .
Original npm · Tarball · package.json
$ cnpm install @adobe/aio-lib-analytics 
SYNC missed versions from official npm registry.

Version Downloads/week Build Status License Greenkeeper badge Codecov Coverage

Adobe I/O Adobe Analytics SDK

Javascript Core SDK wrapping Adobe Analytics 2.0 APIs.

Installing

$ npm install

Usage

  1. Initialize the SDK
var sdk = require('@adobe/aio-lib-analytics');

async function sdkTest() {
  //initialize sdk
  const analyticsClient = await sdk.init('<companyID>', 'x-api-key', '<valid auth token>')
}

Init method returns an Instance of Class AnalyticsCoreAPI

  1. Call methods using initialized sdk
var sdk = require('@adobe/aio-lib-analytics');

async function sdkTest() {
    //initialize sdk
    const analyticsClient = await sdk.init('<companyID>', 'x-api-key', '<valid auth token>')

    //get report suites
    const collections = await analyticsClient.getCollections({limit:5, page:0})

    //get metrics
    const metrics = await analyticsClient.getMetrics(rsid)

    //generate report
    const report = await analyticsClient.getReport(queryJSON)
}

All Methods available under sdk are documented here

Classes

AnalyticsCoreAPI

This class provides methods to call Adobe Analytics APIs. Before calling any method initialize the instance by calling init method on it with valid company id, apiKey and auth token

Functions

init(companyId, apiKey, token)Promise.<AnalyticsCoreAPI>

Returns a Promise that resolves with a new AnalyticsCoreAPI object.

AnalyticsCoreAPI

This class provides methods to call Adobe Analytics APIs. Before calling any method initialize the instance by calling init method on it with valid company id, apiKey and auth token

Kind: global class

analyticsCoreAPI.init(companyId, apiKey, token) ⇒ AnalyticsCoreAPI

Initialize sdk.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
companyId string company ID to be used with Adobe Analytics.
apiKey string Your api key
token string Valid auth token

analyticsCoreAPI.getCalculatedMetrics(options)

Retrieve many calculated metrics. A calculated metric response will always include these default items: id, name, description, rsid, owner, polarity, precision, type Other attributes can be optionally requested through the 'expansion' field:\n\n modified: Date that the metric was last modified (ISO 8601) definition: Calculated metric definition as JSON object compatibility: Products that the metric is compatible with reportSuiteName*: Also return the friendly Report Suite name for the RSID tags*: Gives all existing tags associated with the calculated metric

For more information about calculated metrics go here

Kind: instance method of AnalyticsCoreAPI

Param Type Description
options Object to control calculated metrics search.
options.calculatedMetricFilter Filter list to only include calculated metrics in the specified list\n(comma-delimited list of IDs).
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.limit Number of results per page. Default 10.
options.locale Locale.
options.name Filter list to only include calculated metrics that contains the Name.
options.ownerId Filter list to only include calculated metrics owned by the\nspecified loginId.
options.page Page number (base 0 - first page is "0"). Default 0.
options.rsids Filter list to only include calculated metrics tied to specified\nRSID list (comma-delimited).
options.tagNames Filter list to only include calculated metrics that contains one of\nthe tags.

analyticsCoreAPI.getCalculatedMetricById(id, options)

Retrieve a single calculated metric by id. A calculated metric response will always include these default items: id, name, description, rsid, owner, polarity, precision, type Other attributes can be optionally requested through the 'expansion' field:\n\n modified: Date that the metric was last modified (ISO 8601) definition: Calculated metric definition as JSON object compatibility: Products that the metric is compatible with reportSuiteName*: Also return the friendly Report Suite name for the RSID tags*: Gives all existing tags associated with the calculated metric

For more information about calculated metrics go here

Kind: instance method of AnalyticsCoreAPI

Param Type Description
id string The calculated metric ID to retrieve.
options Object to control calculated metric result
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.locale Locale.

analyticsCoreAPI.getCollections(options)

Retrieves report suites that match the given filters. Returns all report suite types in a single collection.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
options Object to control report suites search.
options.expansion Comma-delimited list of additional metadata fields to include on\nresponse.
options.limit Number of results per page. Default 10.
options.page Page number (base 0 - first page is "0"). Default 0.
options.rsids Filter list to only include suites in this RSID list\n(comma-delimited).
options.rsidContains Filter list to only include suites whose rsid contains rsidContains.

analyticsCoreAPI.getCollectionById(rsid, options)

Retrieves report suite by id. Returns all report suite types in a single collection.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
rsid string The rsid of the suite to return.
options Object to control eport suites search.
options.expansion Comma-delimited list of additional metadata fields to include on\nresponse.

analyticsCoreAPI.getDateRanges(options)

Returns a list of dateranges for the user. This function allows users to store commonly used date ranges so that they\ncan be reused throughout the product.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
options Object to control date range search.
options.expansion Comma-delimited list of additional metadata fields to include on\nresponse.
options.filterByIds Filter list to only include date ranges in the specified list\n(comma-delimited list of IDs).
options.limit Number of results per page. Default 10.
options.locale Locale.
options.page Page number (base 0 - first page is "0"). Default 0.

analyticsCoreAPI.getDateRangeById(dateRangeId, options)

Retrieves configuration for a DateRange..

Kind: instance method of AnalyticsCoreAPI

Param Type Description
dateRangeId string The DateRange id for which to retrieve information.
options Object to control date range result.
options.expansion Comma-delimited list of additional metadata fields to include on\nresponse.
options.locale Locale.

analyticsCoreAPI.getDimensions(rsid, options)

Returns a list of dimensions for a given report suite.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
rsid string A Report Suite ID.
options Object to control dimensions search.
options.classifiable Only include classifiable dimensions.
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.locale Locale.
options.reportable Only include dimensions that are valid within a report.
options.segmentable Only include dimensions that are valid within a segment.

analyticsCoreAPI.getDimensionById(dimensionId, rsid, options)

Returns a dimension for the given report suite and dimension Id.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
dimensionId string The dimension ID. For example a valid id is a value like 'evar1'.
rsid string A Report Suite ID.
options Object to control dimension result.
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.locale Locale.

analyticsCoreAPI.getMetrics(rsid, options)

Returns a list of metrics for the given report suite. This returns the metrics list primarily for the Analytics product. The platform identity API Returns a list of all possible metrics for the supported systems.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
rsid string A Report Suite ID.
options Object to control dimension result.
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.locale Locale that system named metrics should be returned in.
options.segmentable Filter the metrics by if they are valid in a segment.

analyticsCoreAPI.getMetricById(id, rsid, options)

Returns a metric for the given report suite. This returns the metrics list primarily for the Analytics product. The platform identity API Returns a list of all possible metrics for the supported systems.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
id string The id of the metric for which to retrieve info. Note ids are values\nlike pageviews, not metrics/pageviews.
rsid string A Report Suite ID.
options Object to control dimension result.
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.locale Locale that system named metrics should be returned in.

analyticsCoreAPI.getReport(body)

Runs a report for the request. See the Reporting User\nGuide for details.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
body Object report query.

analyticsCoreAPI.getSegments(options)

Retrieve All Segments.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
options Object to control segments search.
options.expansion Comma-delimited list of additional metadata fields\nto include on response.
options.includeType Include additional segments not owned by user. The "all" option\ntakes precedence over "shared".
options.limit Number of results per page. Default 10.
options.locale Locale that system named metrics should be returned in.
options.name Filter list to only include segments that contains the Name.
options.page Page number (base 0 - first page is "0"). Default 0.
options.rsids Filter list to only include segments tied to specified RSID list\n(comma-delimited).
options.segmentFilter Filter list to only include segments in the specified list\n(comma-delimited list of IDs).
options.tagNames Filter list to only include segments that contains one of the tags.

analyticsCoreAPI.validateSegment(rsid, body)

Validate a Segment. Returns a segment validation for the segment contained in the post body of the report.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
rsid string A Report Suite ID.
body Object JSON Segment Definition.

analyticsCoreAPI.getUsers(options)

Returns a list of users for the current user's login company. Retrieves a list of all users for the company designated by the auth\ntoken.

Kind: instance method of AnalyticsCoreAPI

Param Type Description
options Object to control user search.
options.limit Number of results per page. Default 10.
options.page Page number (base 0 - first page is "0"). Default 0.

analyticsCoreAPI.getCurrentUser()

Get the current user.

Kind: instance method of AnalyticsCoreAPI

init(companyId, apiKey, token) ⇒ Promise.<AnalyticsCoreAPI>

Returns a Promise that resolves with a new AnalyticsCoreAPI object.

Kind: global function

Param Type Description
companyId string company ID to be used with Adobe Analytics.
apiKey string Your api key
token string Valid auth token

Debug Logs

LOG_LEVEL=debug <your_call_here>

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Current Tags

  • 2.0.0                                ...           latest (7 months ago)

4 Versions

  • 2.0.0                                ...           7 months ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago