adobe.analytics
Module adobe.analytics
API
Definitions
ballerinax/adobe.analytics Ballerina library
Overview
Adobe Analytics is a web and digital analytics platform for collecting, segmenting and reporting on customer behavior across channels.
The Adobe Analytics connector lets Ballerina applications call the Adobe Analytics 2.0 API to run reports, manage segments, calculated metrics, projects, date ranges, annotations, tags and shares, browse dimensions and metrics, and read users and audit logs. It supports version 2.0 of the Adobe Analytics API.
Key features
- Run ranked, realtime and top-item reports against report suites
- Create, validate and manage segments and calculated metrics
- Browse the dimensions and metrics available for a report suite
- Manage projects, date ranges, annotations, tags and shares
- Read company users and usage audit logs
Setup guide
To use the Adobe Analytics connector, you need an Adobe Analytics product profile and access to the Adobe Developer Console.
Step 1: Create a project and add the Analytics API
- Sign in to the Adobe Developer Console and create a new project.
- Choose Add API, select Adobe Analytics, and pick the OAuth Server-to-Server credential type.
- Assign the credential to a product profile that has access to the report suites you want to use.
Step 2: Note the credentials
Copy the Client ID (used as the API key) and the Client Secret from the credential page.
Step 3: Generate an access token
Request an access token from Adobe IMS. Access tokens expire after 24 hours, so repeat this step to refresh it.
curl -X POST https://ims-na1.adobelogin.com/ims/token/v3 \ -d "client_id=<Client ID>" \ -d "client_secret=<Client Secret>" \ -d "grant_type=client_credentials" \ -d "scope=openid,AdobeID,additional_info.projectedProductContext"
Step 4: Find your global company ID
Call the discovery endpoint with the access token and API key. The globalCompanyId in the response is the value the connector methods take as their first argument.
curl https://analytics.adobe.io/discovery/me \ -H "Authorization: Bearer <access token>" \ -H "x-api-key: <Client ID>"
Quickstart
To use the Adobe Analytics connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the adobe.analytics module.
import ballerinax/adobe.analytics;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and configure the credentials obtained in the steps above:
accessToken = "<Access Token>" apiKey = "<Client ID>" companyId = "<Global Company ID>"
- Create an
analytics:ApiKeysConfigwith the access token and API key, and initialize the connector with it.
configurable string accessToken = ?; configurable string apiKey = ?; configurable string companyId = ?; final analytics:Client analyticsClient = check new ({ authorization: "Bearer " + accessToken, xApiKey: apiKey });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Get the current user
public function main() returns error? { analytics:AnalyticsUser _ = check analyticsClient->getCurrentUser(companyId); }
Step 4: Run the Ballerina application
bal run
Examples
The Adobe Analytics connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
-
Page traffic report - Check that the page dimension and visits metric are available for a report suite, then run a ranked report of the most visited pages for a date range.
-
Workspace asset audit - Identify the authenticated user, collect all company users page by page, count visible projects and list calculated metrics.
Clients
adobe.analytics: Client
The endpoints described here are routed through analytics.adobe.io. In order to use these endpoints you must create an oAuth client that is subscribed to access the Adobe Analytics Reporting API.
To view the API References for non-core Analytics 2.0 APIs, select the API Reference drop-down menu at the top of the page.
Note: Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://analytics.adobe.io/api" - URL of the target service
listAnnotations
function listAnnotations(string globalCompanyId, map<string|string[]> headers, *ListAnnotationsQueries queries) returns ResponsePageAnalyticsAnnotation|errorRetrieve all annotations.
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *ListAnnotationsQueries - Queries to be sent with the request
Return Type
- ResponsePageAnalyticsAnnotation|error - successful operation
createAnnotation
function createAnnotation(string globalCompanyId, Request request, map<string|string[]> headers, *CreateAnnotationQueries queries) returns AnalyticsAnnotation|errorCreate new annotation
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- request Request - JSON-formatted Object containing date range keys/value pairs to be updated
- queries *CreateAnnotationQueries - Queries to be sent with the request
Return Type
- AnalyticsAnnotation|error - successful operation
getAnnotation
function getAnnotation(string globalCompanyId, string id, map<string|string[]> headers, *GetAnnotationQueries queries) returns AnalyticsAnnotation|errorGet existing annotation
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - Annotation ID to retrieve
- queries *GetAnnotationQueries - Queries to be sent with the request
Return Type
- AnalyticsAnnotation|error - successful operation
updateAnnotation
function updateAnnotation(string globalCompanyId, string id, Request request, map<string|string[]> headers, *UpdateAnnotationQueries queries) returns AnalyticsAnnotation|errorUpdate existing annotation
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - Annotation ID to update
- request Request - JSON-formatted Object containing date range keys/value pairs to be updated
- queries *UpdateAnnotationQueries - Queries to be sent with the request
Return Type
- AnalyticsAnnotation|error - successful operation
deleteAnnotation
function deleteAnnotation(string globalCompanyId, string id, map<string|string[]> headers, *DeleteAnnotationQueries queries) returns DeleteResponse|errorDelete existing annotation
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - Annotation ID to update
- queries *DeleteAnnotationQueries - Queries to be sent with the request
Return Type
- DeleteResponse|error - successful operation
findCalculatedMetrics
function findCalculatedMetrics(string globalCompanyId, map<string|string[]> headers, *FindCalculatedMetricsQueries queries) returns AnalyticsCalculatedMetric[]|errorRetrieve multiple calculated metrics
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *FindCalculatedMetricsQueries - Queries to be sent with the request
Return Type
- AnalyticsCalculatedMetric[]|error - successful operation
createCalculatedMetric
function createCalculatedMetric(string globalCompanyId, AnalyticsCalculatedMetric payload, map<string|string[]> headers, *CreateCalculatedMetricQueries queries) returns AnalyticsCalculatedMetric|errorCreate a new calculated metric
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload AnalyticsCalculatedMetric - JSON-formatted Object containing key/value pairs for calculated metric creation
- queries *CreateCalculatedMetricQueries - Queries to be sent with the request
Return Type
- AnalyticsCalculatedMetric|error - successful operation
getCalculatedMetricFunctions
function getCalculatedMetricFunctions(string globalCompanyId, map<string|string[]> headers, *GetCalculatedMetricFunctionsQueries queries) returns CalcMetricFunction[]|errorRetrieve calculated metric functions
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetCalculatedMetricFunctionsQueries - Queries to be sent with the request
Return Type
- CalcMetricFunction[]|error - successful operation
getCalculatedMetricFunction
function getCalculatedMetricFunction(string globalCompanyId, string id, map<string|string[]> headers, *GetCalculatedMetricFunctionQueries queries) returns CalcMetricFunction|errorRetrieve a calculated metric function by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The function ID to retrieve
- queries *GetCalculatedMetricFunctionQueries - Queries to be sent with the request
Return Type
- CalcMetricFunction|error - successful operation
validateCalculatedMetric
function validateCalculatedMetric(string globalCompanyId, AnalyticsCalculatedMetric payload, map<string|string[]> headers, *ValidateCalculatedMetricQueries queries) returns AnalyticsCalculatedMetric|errorValidate a calculated metric definition
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload AnalyticsCalculatedMetric - JSON-formatted Object containing key/value pairs for calculated metric validation
- queries *ValidateCalculatedMetricQueries - Queries to be sent with the request
Return Type
- AnalyticsCalculatedMetric|error - successful operation
findOneCalculatedMetric
function findOneCalculatedMetric(string globalCompanyId, string id, map<string|string[]> headers, *FindOneCalculatedMetricQueries queries) returns AnalyticsCalculatedMetric|errorRetrieve a single calculated metric by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The calculated metric ID to retrieve
- queries *FindOneCalculatedMetricQueries - Queries to be sent with the request
Return Type
- AnalyticsCalculatedMetric|error - successful operation
updateCalculatedMetric
function updateCalculatedMetric(string globalCompanyId, string id, AnalyticsCalculatedMetric payload, map<string|string[]> headers, *UpdateCalculatedMetricQueries queries) returns AnalyticsCalculatedMetric|errorUpdate an existing calculated metric
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - Calculated Metric ID to be updated
- payload AnalyticsCalculatedMetric - JSON-formatted Object containing key/value pairs to be updated
- queries *UpdateCalculatedMetricQueries - Queries to be sent with the request
Return Type
- AnalyticsCalculatedMetric|error - successful operation
deleteCalculatedMetric
function deleteCalculatedMetric(string globalCompanyId, string id, map<string|string[]> headers, *DeleteCalculatedMetricQueries queries) returns DeleteResponse|errorDelete calculated metrics by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The calculated metric ID to be deleted
- queries *DeleteCalculatedMetricQueries - Queries to be sent with the request
Return Type
- DeleteResponse|error - successful operation
findAllSharesForCompany
function findAllSharesForCompany(string globalCompanyId, map<string|string[]> headers, *FindAllSharesForCompanyQueries queries) returns Share[]|errorRetrieve components shared by user
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *FindAllSharesForCompanyQueries - Queries to be sent with the request
updateSharesForComponents
function updateSharesForComponents(string globalCompanyId, SharedComponent[] payload, map<string|string[]> headers, *UpdateSharesForComponentsQueries queries) returns SharedComponent|errorUpdate shared components with users
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload SharedComponent[] - JSON-formatted ARRAY of objects containing key-value pairs that conform to the schema
- queries *UpdateSharesForComponentsQueries - Queries to be sent with the request
Return Type
- SharedComponent|error - successful operation
saveShareMyCompany
function saveShareMyCompany(string globalCompanyId, Share payload, map<string|string[]> headers, *SaveShareMyCompanyQueries queries) returns Share|errorShare component with user
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload Share - JSON-formatted Share object containing key-value pairs that conform to the Share schema
- queries *SaveShareMyCompanyQueries - Queries to be sent with the request
searchComponentShares
function searchComponentShares(string globalCompanyId, ComponentSearch payload, map<string|string[]> headers, *SearchComponentSharesQueries queries) returns SavedSharedComponent|errorCreate search for shared components
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload ComponentSearch - items to search for
- queries *SearchComponentSharesQueries - Queries to be sent with the request
Return Type
- SavedSharedComponent|error - successful operation
getShareById
function getShareById(string globalCompanyId, string id, map<string|string[]> headers) returns Share|errorRetrieve details of share by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The share ID to return details for
deleteShare
function deleteShare(string globalCompanyId, string id, map<string|string[]> headers, *DeleteShareQueries queries) returns record { record {}... }|errorDelete share by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The shareId to be deleted
- queries *DeleteShareQueries - Queries to be sent with the request
Return Type
- record { record {}... }|error - successful operation
getComponentsSharedToMe
function getComponentsSharedToMe(string globalCompanyId, map<string|string[]> headers, *GetComponentsSharedToMeQueries queries) returns string[]|errorRetrieve component IDs shared with user
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetComponentsSharedToMeQueries - Queries to be sent with the request
searchComponentTags
function searchComponentTags(string globalCompanyId, ComponentSearch payload, map<string|string[]> headers, *SearchComponentTagsQueries queries) returns TaggedComponent|errorCreate search for component tags
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload ComponentSearch - items to search for
- queries *SearchComponentTagsQueries - Queries to be sent with the request
Return Type
- TaggedComponent|error - successful operation
findAllTagsForCompany
function findAllTagsForCompany(string globalCompanyId, map<string|string[]> headers, *FindAllTagsForCompanyQueries queries) returns Tag[]|errorRetrieve tags for current user company
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *FindAllTagsForCompanyQueries - Queries to be sent with the request
saveTagListForCompany
function saveTagListForCompany(string globalCompanyId, Tag[] payload, map<string|string[]> headers) returns Tag[]|errorCreate tags for current user company
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload Tag[] - JSON-formatted array of Tag objects containing key-value pairs
deleteTagItemsFromComponents
function deleteTagItemsFromComponents(string globalCompanyId, map<string|string[]> headers, *DeleteTagItemsFromComponentsQueries queries) returns record { record {}... }[]|errorDelete tags from components
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *DeleteTagItemsFromComponentsQueries - Queries to be sent with the request
Return Type
- record { record {}... }[]|error - successful operation
getTagListByComponentIdAndComponentType
function getTagListByComponentIdAndComponentType(string globalCompanyId, map<string|string[]> headers, *GetTagListByComponentIdAndComponentTypeQueries queries) returns Tag[]|errorRetrieve component tags by component ID and component type
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetTagListByComponentIdAndComponentTypeQueries - Queries to be sent with the request
saveTagComponentList
function saveTagComponentList(string globalCompanyId, TaggedComponent[] payload, map<string|string[]> headers) returns TaggedComponent[]|errorUpdate tags for component
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload TaggedComponent[] - JSON-formatted object containing key-value pairs that conform to the schema
Return Type
- TaggedComponent[]|error - successful operation
getTagById
function getTagById(string globalCompanyId, Signed32 id, map<string|string[]> headers) returns Tag|errorRetrieve tag by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id Signed32 - Tag ID to be retrieved
deleteTag
function deleteTag(string globalCompanyId, Signed32 id, map<string|string[]> headers) returns record { record {}... }[]|errorDelete tag from component
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id Signed32 - The tagId to be deleted
Return Type
- record { record {}... }[]|error - successful operation
getComponentsByTagName
function getComponentsByTagName(string globalCompanyId, map<string|string[]> headers, *GetComponentsByTagNameQueries queries) returns string[]|errorRetrieve component IDs associated with tag names
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetComponentsByTagNameQueries - Queries to be sent with the request
getDateRange
function getDateRange(string globalCompanyId, string id, map<string|string[]> headers, *GetDateRangeQueries queries) returns ExpandedDateRange|errorRetrieve configuration for a date range
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The DateRange id for which to retrieve information
- queries *GetDateRangeQueries - Queries to be sent with the request
Return Type
- ExpandedDateRange|error - successful operation
updateDateRange
function updateDateRange(string globalCompanyId, string id, Request request, map<string|string[]> headers, *UpdateDateRangeQueries queries) returns ExpandedDateRange|errorUpdate configuration for a date range
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The DateRange id for which to retrieve information
- request Request - JSON-formatted Object containing date range keys/value pairs to be updated
- queries *UpdateDateRangeQueries - Queries to be sent with the request
Return Type
- ExpandedDateRange|error - successful operation
deleteDateRange
function deleteDateRange(string globalCompanyId, string id, map<string|string[]> headers, *DeleteDateRangeQueries queries) returns DeleteResponse|errorDelete a date range
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The DateRange id for which to retrieve information
- queries *DeleteDateRangeQueries - Queries to be sent with the request
Return Type
- DeleteResponse|error - successful operation
getDateRangesForUser
function getDateRangesForUser(string globalCompanyId, map<string|string[]> headers, *GetDateRangesForUserQueries queries) returns ResponsePageExpandedDateRange|errorRetrieve user's date ranges
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetDateRangesForUserQueries - Queries to be sent with the request
Return Type
- ResponsePageExpandedDateRange|error - successful operation
createDateRange
function createDateRange(string globalCompanyId, Request request, map<string|string[]> headers, *CreateDateRangeQueries queries) returns ExpandedDateRange|errorCreate a date range
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- request Request - JSON-formatted Object containing date range keys/value pairs to be updated
- queries *CreateDateRangeQueries - Queries to be sent with the request
Return Type
- ExpandedDateRange|error - successful operation
getDimensionsForReportSuite
function getDimensionsForReportSuite(string globalCompanyId, map<string|string[]> headers, *GetDimensionsForReportSuiteQueries queries) returns AnalyticsDimension[]|errorRetrieve dimensions for a report suite
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetDimensionsForReportSuiteQueries - Queries to be sent with the request
Return Type
- AnalyticsDimension[]|error - successful operation
getDimensionForReportSuite
function getDimensionForReportSuite(string globalCompanyId, string id, map<string|string[]> headers, *GetDimensionForReportSuiteQueries queries) returns AnalyticsDimension|errorRetrieve a dimension by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The dimension ID. For example a valid id is a value like 'evar1'
- queries *GetDimensionForReportSuiteQueries - Queries to be sent with the request
Return Type
- AnalyticsDimension|error - successful operation
getMetricsForReportSuite
function getMetricsForReportSuite(string globalCompanyId, map<string|string[]> headers, *GetMetricsForReportSuiteQueries queries) returns AnalyticsMetric[]|errorRetrieve metrics for a report suite
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetMetricsForReportSuiteQueries - Queries to be sent with the request
Return Type
- AnalyticsMetric[]|error - successful operation
getMetricForReportSuite
function getMetricForReportSuite(string globalCompanyId, string id, map<string|string[]> headers, *GetMetricForReportSuiteQueries queries) returns AnalyticsMetric|errorRetrieve a metric by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews
- queries *GetMetricForReportSuiteQueries - Queries to be sent with the request
Return Type
- AnalyticsMetric|error - successful operation
getProjectConfiguration
function getProjectConfiguration(string globalCompanyId, string id, map<string|string[]> headers, *GetProjectConfigurationQueries queries) returns AnalyticsProject|errorRetrieve project configuration
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The Project id for which to retrieve information
- queries *GetProjectConfigurationQueries - Queries to be sent with the request
Return Type
- AnalyticsProject|error - successful operation
updateProjectConfiguration
function updateProjectConfiguration(string globalCompanyId, string id, Request request, map<string|string[]> headers, *UpdateProjectConfigurationQueries queries) returns AnalyticsProject|errorUpdate a project configuration
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The Project id for which to retrieve information
- request Request - JSON-formatted Object containing project keys/value pairs to be updated
- queries *UpdateProjectConfigurationQueries - Queries to be sent with the request
Return Type
- AnalyticsProject|error - successful operation
deleteProject
function deleteProject(string globalCompanyId, string id, map<string|string[]> headers, *DeleteProjectQueries queries) returns DeleteResponse|errorDelete a project
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The Project id for which to retrieve information
- queries *DeleteProjectQueries - Queries to be sent with the request
Return Type
- DeleteResponse|error - successful operation
validateProjectDefinition
function validateProjectDefinition(string globalCompanyId, AnalyticsProject payload, map<string|string[]> headers, *ValidateProjectDefinitionQueries queries) returns ProjectCompatibility|errorCreates a valid project definition
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload AnalyticsProject - JSON-formatted Object containing key/value pairs for Project validation
- queries *ValidateProjectDefinitionQueries - Queries to be sent with the request
Return Type
- ProjectCompatibility|error - successful operation
getProjectsOfUser
function getProjectsOfUser(string globalCompanyId, map<string|string[]> headers, *GetProjectsOfUserQueries queries) returns AnalyticsProject[]|errorRetrieve user's projects
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetProjectsOfUserQueries - Queries to be sent with the request
Return Type
- AnalyticsProject[]|error - successful operation
createProject
function createProject(string globalCompanyId, Request request, map<string|string[]> headers, *CreateProjectQueries queries) returns AnalyticsProject|errorCreate a project
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- request Request - JSON-formatted Object containing project keys/value pairs to be updated
- queries *CreateProjectQueries - Queries to be sent with the request
Return Type
- AnalyticsProject|error - successful operation
runReport
function runReport(string globalCompanyId, RankedRequest payload, map<string|string[]> headers) returns RankedReportData|errorCreate a report
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload RankedRequest - Report request with dimension, metrics, filters and date range
Return Type
- RankedReportData|error - Successful operation
runRealtimeReport
function runRealtimeReport(string globalCompanyId, RankedRequest payload, map<string|string[]> headers) returns RankedReportData|errorCreate a realtime report
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload RankedRequest - Realtime report request with dimension, metrics and filters
Return Type
- RankedReportData|error - Successful operation
runTopItemReport
function runTopItemReport(string globalCompanyId, map<string|string[]> headers, *RunTopItemReportQueries queries) returns UnhashReportData|errorRetrieve top items report
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *RunTopItemReportQueries - Queries to be sent with the request
Return Type
- UnhashReportData|error - Successful operation
getAllSegments
function getAllSegments(string globalCompanyId, map<string|string[]> headers, *GetAllSegmentsQueries queries) returns AnalyticsSegmentResponseItem|errorRetrieve all segments
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetAllSegmentsQueries - Queries to be sent with the request
Return Type
- AnalyticsSegmentResponseItem|error - successful operation
createSegment
function createSegment(string globalCompanyId, AnalyticsSegment payload, map<string|string[]> headers, *CreateSegmentQueries queries) returns AnalyticsSegmentResponseItem|errorCreate a segment
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload AnalyticsSegment - JSON-formatted Object containing key/value pairs for segment creation
- queries *CreateSegmentQueries - Queries to be sent with the request
Return Type
- AnalyticsSegmentResponseItem|error - successful operation
validateSegment
function validateSegment(string globalCompanyId, AnalyticsSegmentDefinition payload, map<string|string[]> headers, *ValidateSegmentQueries queries) returns SegmentCompatibility|errorCreate validation for segment
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- payload AnalyticsSegmentDefinition - Segment definition
- queries *ValidateSegmentQueries - Queries to be sent with the request
Return Type
- SegmentCompatibility|error - successful operation
getSegment
function getSegment(string globalCompanyId, string id, map<string|string[]> headers, *GetSegmentQueries queries) returns AnalyticsSegmentResponseItem|errorRetrieve a segment by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The segment ID to retrieve
- queries *GetSegmentQueries - Queries to be sent with the request
Return Type
- AnalyticsSegmentResponseItem|error - successful operation
updateSegment
function updateSegment(string globalCompanyId, string id, record { record {}... } payload, map<string|string[]> headers, *UpdateSegmentQueries queries) returns AnalyticsSegmentResponseItem|errorUpdate a segment by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - Segment ID to be updated
- payload record { record {}... } - JSON-formatted Object containing key/value pairs to be updated
- queries *UpdateSegmentQueries - Queries to be sent with the request
Return Type
- AnalyticsSegmentResponseItem|error - successful operation
deleteSegment
function deleteSegment(string globalCompanyId, string id, map<string|string[]> headers, *DeleteSegmentQueries queries) returns string|errorDelete a segment by ID
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- id string - The segment ID to be deleted
- queries *DeleteSegmentQueries - Queries to be sent with the request
listAllUsersForCompany
function listAllUsersForCompany(string globalCompanyId, map<string|string[]> headers, *ListAllUsersForCompanyQueries queries) returns AnalyticsUser[]|errorRetrieve users for current company
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *ListAllUsersForCompanyQueries - Queries to be sent with the request
Return Type
- AnalyticsUser[]|error - successful operation
getCurrentUser
function getCurrentUser(string globalCompanyId, map<string|string[]> headers) returns AnalyticsUser|errorRetrieve current user
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
Return Type
- AnalyticsUser|error - successful operation
getUsageAccessLogs
function getUsageAccessLogs(string globalCompanyId, map<string|string[]> headers, *GetUsageAccessLogsQueries queries) returns ResponsePageUsageLogDto|errorRetrieve logs for provided search criteria
Parameters
- globalCompanyId string - The Global Company ID for the Adobe Analytics organization
- queries *GetUsageAccessLogsQueries - Queries to be sent with the request
Return Type
- ResponsePageUsageLogDto|error - External API Error; Data could not be retrieved
Records
adobe.analytics: AlternateVariableNames
Fields
- curatedName? string -
- name? string -
- baseName? string -
adobe.analytics: AnalyticsAnnotation
Fields
- owner? Owner -
- color? "STANDARD1"|"STANDARD2"|"STANDARD3"|"STANDARD4"|"STANDARD5"|"STANDARD6"|"STANDARD7"|"STANDARD8"|"STANDARD9" -
- dateRange? string -
- systemUserOwned? boolean -
- description? string -
- rsid? string -
- tags? record { record {}... }[] -
- shares? record { record {}... }[] -
- approved? boolean -
- companyId? Signed32 -
- createdDate? string -
- reportSuiteName? string -
- modifiedById? string -
- scope? AnnotationScope -
- name? string -
- modifiedDate? string -
- usageSummary? record { record {}... } -
- id? string -
- favorite? boolean -
- applyToAllReports? boolean -
adobe.analytics: AnalyticsCalculatedMetric
Fields
- owner? Owner -
- created? string - Calculated metric creation date
- precision? Signed32 - Number of decimal places to include in calculated metric result
- siteTitle? string -
- description? string -
- rsid? string - The report suite id for which the component was created/updated
- 'type? "CURRENCY"|"TIME"|"DECIMAL"|"PERCENT" -
- tags? Tag[] -
- reportSuiteName? string - The report suite name for which the component was created/updated
- name? string -
- modified? string -
- definition CalculatedMetricDef -
- id? string - System generated id
- categories? string[] -
- polarity? "positive"|"negative" - Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive
adobe.analytics: AnalyticsDimension
Fields
- extraTitleInfo? string -
- parent? string -
- expirationType? "visit"|"page_view"|"never"|"minute"|"hour"|"day"|"week"|"month"|"quarter"|"year"|"purchase"|"product_view"|"cart_open"|"cart_checkout"|"cart_add"|"cart_remove"|"cart_view"|"event" - The configured expiration type for the eVar, determining how long the value persists across hits
- bindingEvents? string[] - Metric IDs that trigger merchandising binding. Populated only for merchandising eVars configured with event triggers
- pathable? boolean -
- dataType? "text"|"counter" - The eVar storage type
- merchandisingSyntax? "product"|"conversion_variable" - Merchandising binding style. Populated only for merchandising eVars
- description? string -
- allowedForReporting? boolean -
- reportable? string[] -
- title? string -
- 'type? "STRING"|"INT"|"DECIMAL"|"CURRENCY"|"PERCENT"|"TIME"|"ENUM"|"ORDERED_ENUM" -
- allocationType? "most_recent_last"|"original_value_first"|"linear"|"linear_to_items"|"merchandising_first"|"merchandising_last" - The configured allocation type for the eVar. Preserves distinctions collapsed by attributionModel.func
- expirationCustomDays? int - Number of days in the expiration window. Semantically meaningful when expirationType is 'day'
- tags? Tag[] -
- attributionModel? record { record {}... } -
- noneSettings? NoneSettings -
- segmentable? boolean -
- name? string -
- id? string -
- categories? string[] -
- category? string -
- support? string[] -
- ecomAllocationType? "first"|"last"|"merchandising" - High-level allocation bucket. Returned automatically when expansion=attributionModel is requested; does not have its own expansion flag
adobe.analytics: AnalyticsMetric
Fields
- extraTitleInfo? string -
- allocation? boolean -
- precision? Signed32 -
- description? string -
- allowedForReporting? boolean -
- title? string -
- 'type? "STRING"|"INT"|"DECIMAL"|"CURRENCY"|"PERCENT"|"TIME"|"ENUM"|"ORDERED_ENUM" -
- tags? Tag[] -
- helpLink? string -
- segmentable? boolean -
- name? string -
- id? string -
- categories? string[] -
- category? string -
- support? string[] -
- calculated? boolean -
- polarity? "positive"|"negative" -
adobe.analytics: AnalyticsProject
Fields
- template? boolean -
- owner? Owner -
- complexity? record {} -
- externalReferences? record { string[]... } -
- accessLevel? string -
- migratedIds? string[] -
- created? string -
- siteTitle? string -
- description? string -
- rsid? string - The report suite id for which the component was created/updated
- 'type? "project"|"mobileScorecard" -
- tags? record { record {}... }[] -
- shares? record { record {}... }[] -
- approved? boolean -
- reportSuiteName? string - The report suite name for which the component was created/updated
- name? string -
- modified? string -
- definition? JsonNode -
- usageSummary? record { record {}... } -
- id? string - System generated id
- versionNotes? string -
- companyTemplate? boolean -
- favorite? boolean -
adobe.analytics: AnalyticsSegment
Fields
- owner? Owner -
- created? string -
- siteTitle? string - A name for the report suite. This is deprecated and should use the report suite name instead
- description? string - A description of the segment
- rsid? string - The report suite id
- tags? Tag[] - All existing tags associated with the segment
- reportSuiteName? string - The friendly name for the report suite id
- name? string - A name for the segment
- modified? string -
- definition? AnalyticsSegmentDefinition -
- categories? string[] -
- compatibility? SegmentCompatibility -
- definitionLastModified? string -
adobe.analytics: AnalyticsSegmentDefinition
Fields
- container? AnalyticsSegmentDefinitionContainer -
- func? string -
- version? Signed32[] -
adobe.analytics: AnalyticsSegmentDefinitionContainer
Fields
- func? string -
- context? string -
adobe.analytics: AnalyticsSegmentDefinitionContainerPred
Fields
- str? string -
- func? string -
adobe.analytics: AnalyticsSegmentDefinitionContainerPredVal
Fields
- func? string -
- name? string -
- description? string -
adobe.analytics: AnalyticsSegmentResponseItem
Fields
- owner? Owner -
- created? string -
- siteTitle? string - A name for the report suite. This is deprecated and should use the report suite name instead
- description? string - A description of the segment
- rsid? string - The report suite id
- tags? Tag[] - All existing tags associated with the segment
- reportSuiteName? string - The friendly name for the report suite id
- name? string - A name for the segment
- modified? string -
- definition? AnalyticsSegmentDefinition -
- id? string - Id of the segment
- categories? string[] -
- compatibility? SegmentCompatibility -
- definitionLastModified? string -
adobe.analytics: AnalyticsUser
Fields
- lastName? string -
- loginId? Signed32 -
- fullName? string -
- lastAccess? string -
- login? string -
- title? string -
- changePassword? boolean -
- firstName? string -
- companyid? Signed32 -
- phoneNumber? string -
- disabled? boolean -
- imsUserId? string -
- tempLoginEnd? string -
- email? string -
- createDate? string -
adobe.analytics: AnnotationScope
Fields
- metrics? ScopeMetric[] -
- filters? ScopeFilter[] -
adobe.analytics: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - The access token from the Adobe Analytics API client integration, prefixed with "Bearer ".
- xApiKey string - The API key (client ID) copied from the Adobe Analytics API client integration.
adobe.analytics: CalcMetricFunction
Fields
- exampleKey? string - Calculated Metric Function example key
- name? string - Calculated Metric Function name
- namespace? string - Calculated Metric Function namespace
- description? string - Calculated Metric Function description
- persistable? boolean - If a Calculated Metric Function is persistable
- definition? CalcMetricFunctionDef -
- id? string - Calculated Metric Function ID
- category? string - Calculated Metric Function category
- example? string - Calculated Metric Function example
adobe.analytics: CalcMetricFunctionDef
Fields
- func? string -
- formula? record { record {}... } -
- parameters? CalcMetricFunctionParameter[] -
- version? Signed32[] -
adobe.analytics: CalcMetricFunctionParameter
Fields
- defaultValue? record {} -
- func? string -
- descKey? string -
- name? string -
- friendlyNameKey? string -
- description? string -
- 'type? string -
- friendlyName? string -
adobe.analytics: CalculatedMetricDef
adobe.analytics: ComponentSearch
Fields
- componentType? string -
- componentIds? string[] -
adobe.analytics: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
adobe.analytics: CreateAnnotationQueries
Represents the Queries record for the operation: createAnnotation
Fields
- locale string(default "en_US") - Locale
- expansion? ("name"|"description"|"dateRange"|"color"|"applyToAllReports"|"scope"|"createdDate"|"modifiedDate"|"modifiedById"|"owner"|"companyId"|"rsid"|"approved"|"favorite"|"shares"|"sharesFullName"|"tags"|"usageSummary"|"usageSummaryWithRelevancyScore"|"ownerFullName"|"reportSuiteName")[] - Comma-delimited list of additional annotation metadata fields to include on response
adobe.analytics: CreateCalculatedMetricQueries
Represents the Queries record for the operation: createCalculatedMetric
Fields
- locale string(default "en_US") - Locale
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"definition"|"compatibility"|"categories")[] - Comma-delimited list of additional calculated metric metadata fields to include on response
adobe.analytics: CreateDateRangeQueries
Represents the Queries record for the operation: createDateRange
Fields
- locale string(default "en_US") - Locale
- newDefinition boolean(default false) - Use the new JSON def
- expansion? ("definition"|"ownerFullName"|"modified"|"approved"|"favorite"|"shares"|"tags"|"sharesFullName"|"usageSummary"|"usageSummaryWithRelevancyScore")[] - Comma-delimited list of additional date range metadata fields to include on response
adobe.analytics: CreateProjectQueries
Represents the Queries record for the operation: createProject
Fields
- locale string(default "en_US") - Locale
- expansion? ("reportSuiteName"|"shares"|"tags"|"accessLevel"|"modified"|"externalReferences"|"definition")[] - Comma-delimited list of additional project metadata fields to include on response
adobe.analytics: CreateSegmentQueries
Represents the Queries record for the operation: createSegment
Fields
- locale string(default "en_US") - Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"compatibility"|"definition"|"publishingStatus"|"definitionLastModified"|"categories")[] - Comma-delimited list of additional segment metadata fields to include on response
adobe.analytics: DeleteAnnotationQueries
Represents the Queries record for the operation: deleteAnnotation
Fields
- locale string(default "en_US") - Locale
adobe.analytics: DeleteCalculatedMetricQueries
Represents the Queries record for the operation: deleteCalculatedMetric
Fields
- locale string(default "en_US") - Locale
adobe.analytics: DeleteDateRangeQueries
Represents the Queries record for the operation: deleteDateRange
Fields
- locale string(default "en_US") - Locale
adobe.analytics: DeleteProjectQueries
Represents the Queries record for the operation: deleteProject
Fields
- locale string(default "en_US") - Locale
adobe.analytics: DeleteResponse
Fields
- result? string -
- message? string -
adobe.analytics: DeleteSegmentQueries
Represents the Queries record for the operation: deleteSegment
Fields
- locale string(default "en_US") - Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'
adobe.analytics: DeleteShareQueries
Represents the Queries record for the operation: deleteShare
Fields
- locale string(default "en_US") - Locale
adobe.analytics: DeleteTagItemsFromComponentsQueries
Represents the Queries record for the operation: deleteTagItemsFromComponents
Fields
- componentType "segment"|"dashboard"|"bookmark"|"calculatedMetric"|"project"|"dateRange"|"metric"|"dimension"|"virtualReportSuite"|"scheduledJob"|"alert"|"classificationSet" - The component type to operate on
- componentIds string - Comma-separated list of componentIds to operate on
adobe.analytics: ExpandedDateRange
Fields
- owner? record {} -
- template? boolean -
- systemUserOwned? boolean -
- disabledDate? string -
- description? string -
- tags? record { record {}... }[] -
- shares? record { record {}... }[] -
- companyId? Signed32 -
- approved? boolean -
- alternateVariableNames? AlternateVariableNames -
- name? string -
- curatedItem? boolean -
- modified? string -
- definition? record {} -
- usageSummary? record { record {}... } -
- id? string -
- favorite? boolean -
- imsOrgId? string -
- createDate? string -
adobe.analytics: FindAllSharesForCompanyQueries
Represents the Queries record for the operation: findAllSharesForCompany
Fields
- includeType? ("sharedTo")[] - Include additional shares not owned by the user
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
- userid? Signed32 - The user ID to return details for. Only admins may use this option
adobe.analytics: FindAllTagsForCompanyQueries
Represents the Queries record for the operation: findAllTagsForCompany
Fields
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
adobe.analytics: FindCalculatedMetricsQueries
Represents the Queries record for the operation: findCalculatedMetrics
Fields
- includeType? ("all"|"shared"|"templates")[] - Include additional calculated metrics not owned by user. The "all" option takes precedence over "shared"
- sortProperty string(default "id") - Property to sort by (name, modified_date, id is currently allowed)
- rsids? string - Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)
- ownerId? Signed32 - Filter list to only include calculated metrics owned by the specified loginId
- locale string(default "en_US") - Locale
- tagNames? string - Filter list to only include calculated metrics that contains one of the tags
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"definition"|"compatibility"|"categories")[] - Comma-delimited list of additional calculated metric metadata fields to include on response
- approved? boolean - Filter list to only include calculated metrics that are approved
- sortDirection string(default "ASC") - Sort direction (ASC or DESC)
- filterByIds? string - Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter
- name? string - Filter list to only include calculated metrics that contains the Name
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
- favorite? boolean - Filter list to only include calculated metrics that are favorites
- toBeUsedInRsid? string - The report suite where the calculated metric intended to be used. This report suite will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved
adobe.analytics: FindOneCalculatedMetricQueries
Represents the Queries record for the operation: findOneCalculatedMetric
Fields
- locale string(default "en_US") - Locale
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"definition"|"compatibility"|"categories")[] - Comma-delimited list of additional calculated metric metadata fields to include on response
adobe.analytics: GetAllSegmentsQueries
Represents the Queries record for the operation: getAllSegments
Fields
- sortDirection string(default "ASC") - Sort direction (ASC or DESC
- includeType? ("shared"|"all"|"templates")[] - Include additional segments not owned by user. The "all" option takes precedence over "shared"
- sortProperty string(default "id") - Property to sort by (name, modified_date, id is currently allowed)
- segmentFilter? string - Filter list to only include segments in the specified list (comma-delimited list of IDs)
- name? string - Filter list to only include segments that contains the Name
- 'limit int(default 10) - Number of results per page
- rsids? string - Filter list to only include segments tied to specified RSID list (comma-delimited)
- filterByPublishedSegments "all"|"true"|"false" (default "all") - Filter list to only include segments where the published field is set to one of the allowable values (all, true, false)
- page int(default 0) - Page number (base 0 - first page is "0")
- locale string(default "en_US") - Locale
- tagNames? string - Filter list to only include segments that contains one of the tags
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"compatibility"|"definition"|"publishingStatus"|"definitionLastModified"|"categories")[] - Comma-delimited list of additional segment metadata fields to include on response
adobe.analytics: GetAnnotationQueries
Represents the Queries record for the operation: getAnnotation
Fields
- locale string(default "en_US") - Locale
- expansion? ("name"|"description"|"dateRange"|"color"|"applyToAllReports"|"scope"|"createdDate"|"modifiedDate"|"modifiedById"|"owner"|"companyId"|"rsid"|"approved"|"favorite"|"shares"|"sharesFullName"|"tags"|"usageSummary"|"usageSummaryWithRelevancyScore"|"ownerFullName"|"reportSuiteName")[] - Comma-delimited list of additional annotation metadata fields to include on response
adobe.analytics: GetCalculatedMetricFunctionQueries
Represents the Queries record for the operation: getCalculatedMetricFunction
Fields
- locale string(default "en_US") - Locale
adobe.analytics: GetCalculatedMetricFunctionsQueries
Represents the Queries record for the operation: getCalculatedMetricFunctions
Fields
- locale string(default "en_US") - Locale
adobe.analytics: GetComponentsByTagNameQueries
Represents the Queries record for the operation: getComponentsByTagName
Fields
- componentType "segment"|"dashboard"|"bookmark"|"calculatedMetric"|"project"|"dateRange"|"metric"|"dimension"|"virtualReportSuite"|"scheduledJob"|"alert"|"classificationSet" - The component type to operate on
- tagNames string - Comma separated list of tag names
adobe.analytics: GetComponentsSharedToMeQueries
Represents the Queries record for the operation: getComponentsSharedToMe
Fields
- componentType string - ComponentType to return
adobe.analytics: GetDateRangeQueries
Represents the Queries record for the operation: getDateRange
Fields
- locale string(default "en_US") - Locale
- newDefinition boolean(default false) - Use the new JSON def
- expansion? ("definition"|"ownerFullName"|"modified"|"approved"|"favorite"|"shares"|"tags"|"sharesFullName"|"usageSummary"|"usageSummaryWithRelevancyScore")[] - Comma-delimited list of additional date range metadata fields to include on response
adobe.analytics: GetDateRangesForUserQueries
Represents the Queries record for the operation: getDateRangesForUser
Fields
- includeType? ("all"|"shared"|"templates"|"curatedItem")[] - Include additional dateranges not owned by user. The "all" option takes precedence over "shared"
- filterByIds? string - Filter list to only include date ranges in the specified list (comma-delimited list of IDs)
- filterByModifiedAfter? string - Filter list to only include date ranges modified since this date (ISO8601 format)
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
- locale string(default "en_US") - Locale
- newDefinition boolean(default false) - Use the new JSON def
- expansion? ("definition"|"ownerFullName"|"modified"|"approved"|"favorite"|"shares"|"tags"|"sharesFullName"|"usageSummary"|"usageSummaryWithRelevancyScore")[] - Comma-delimited list of additional date range metadata fields to include on response
- curatedRsid? string - Include the curatedItem status for given Rsid
adobe.analytics: GetDimensionForReportSuiteQueries
Represents the Queries record for the operation: getDimensionForReportSuite
Fields
- rsid string - The report suite ID
- locale string(default "en_US") - The locale to use for returning system named dimensions
- expansion? ("tags"|"allowedForReporting"|"attributionModel"|"categories"|"allocationType"|"expirationType"|"expirationCustomDays"|"dataType"|"bindingEvents"|"merchandisingSyntax")[] - Add extra metadata to items (comma-delimited list)
adobe.analytics: GetDimensionsForReportSuiteQueries
Represents the Queries record for the operation: getDimensionsForReportSuite
Fields
- segmentable? true - Only include dimensions that are valid within a segment
- classifiable boolean(default false) - Only include classifiable dimensions
- rsid string - A report suite ID
- reportable? true - Only include dimensions that are valid within a report
- locale string(default "en_US") - Locale
- expansion? ("tags"|"allowedForReporting"|"attributionModel"|"categories"|"allocationType"|"expirationType"|"expirationCustomDays"|"dataType"|"bindingEvents"|"merchandisingSyntax")[] - Add extra metadata to items (comma-delimited list)
adobe.analytics: GetMetricForReportSuiteQueries
Represents the Queries record for the operation: getMetricForReportSuite
Fields
- rsid string - ID of desired report suite
- locale string(default "en_US") - Locale that system named metrics should be returned in
- expansion? ("tags"|"allowedForReporting"|"categories")[] - Add extra metadata to items (comma-delimited list)
adobe.analytics: GetMetricsForReportSuiteQueries
Represents the Queries record for the operation: getMetricsForReportSuite
Fields
- segmentable boolean(default false) - Filter the metrics by if they are valid in a segment
- rsid string - ID of desired report suite
- locale string(default "en_US") - Locale that system named metrics should be returned in
- expansion? ("tags"|"allowedForReporting"|"categories")[] - Add extra metadata to items (comma-delimited list)
adobe.analytics: GetProjectConfigurationQueries
Represents the Queries record for the operation: getProjectConfiguration
Fields
- locale string(default "en_US") - Locale
- expansion? ("reportSuiteName"|"shares"|"tags"|"accessLevel"|"modified"|"externalReferences"|"definition")[] - Comma-delimited list of additional project metadata fields to include on response
adobe.analytics: GetProjectsOfUserQueries
Represents the Queries record for the operation: getProjectsOfUser
Fields
- pagination "true"|"false" (default "false") - return paginated results
- includeType? ("all"|"shared")[] - Include additional projects not owned by user. The "all" option takes precedence over "shared". If neither guided, or project is included, both types are returned
- filterByIds? string - Filter list to only include projects in the specified list (comma-delimited list of IDs)
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
- locale string(default "en_US") - Locale
- ownerId? Signed32 - Filter list to only include projects owned by the specified loginId
- expansion? ("reportSuiteName"|"shares"|"tags"|"accessLevel"|"modified"|"externalReferences"|"definition")[] - Comma-delimited list of additional project metadata fields to include on response
adobe.analytics: GetSegmentQueries
Represents the Queries record for the operation: getSegment
Fields
- locale string(default "en_US") - Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"compatibility"|"definition"|"publishingStatus"|"definitionLastModified"|"categories")[] - Comma-delimited list of additional segment metadata fields to include on response
adobe.analytics: GetTagListByComponentIdAndComponentTypeQueries
Represents the Queries record for the operation: getTagListByComponentIdAndComponentType
Fields
- componentType "segment"|"dashboard"|"bookmark"|"calculatedMetric"|"project"|"dateRange"|"metric"|"dimension"|"virtualReportSuite"|"scheduledJob"|"alert"|"classificationSet" - The component type to operate on
- componentId string - The componentId to operate on. Currently this is just the segmentId
adobe.analytics: GetUsageAccessLogsQueries
Represents the Queries record for the operation: getUsageAccessLogs
Fields
- endDate string(default "2021-01-02T14:32:33-07") - End date for the maximum of a 3 month period
- ip? string - The IP address you want to filter logs by
- 'limit Signed32(default 10) - Number of results per page
- rsid? string - The report suite ID you want to filter logs by
- eventType? string - The numeric id for the event type you want to filter logs by
- page Signed32(default 0) - Page number (base 0 - first page is "0")
- login? string - The login value of the user you want to filter logs by
- event? string - The event description you want to filter logs by. No wildcards permitted
- startDate string(default "2021-01-01T00:00:00-07") - Start date for the maximum of a 3 month period
adobe.analytics: JsonNode
Fields
- integralNumber? boolean -
- double? boolean -
- valueNode? boolean -
- floatingPointNumber? boolean -
- bigInteger? boolean -
- 'float? boolean -
- nodeType? "ARRAY"|"BINARY"|"BOOLEAN"|"MISSING"|"NULL"|"NUMBER"|"OBJECT"|"POJO"|"STRING" -
- 'int? boolean -
- long? boolean -
- textual? boolean -
- missingNode? boolean -
- pojo? boolean -
- number? boolean -
- 'boolean? boolean -
- 'null? boolean -
- array? boolean -
- binary? boolean -
- containerNode? boolean -
- short? boolean -
- bigDecimal? boolean -
- 'object? boolean -
adobe.analytics: ListAllUsersForCompanyQueries
Represents the Queries record for the operation: listAllUsersForCompany
Fields
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
adobe.analytics: ListAnnotationsQueries
Represents the Queries record for the operation: listAnnotations
Fields
- sortDirection? int - Sort direction (ASC or DESC
- includeType? ("all"|"shared")[] - Include additional annotations not owned by user. The "all" option takes precedence over "shared"
- filterByIds? string -
- filterByModifiedAfter? string - Filter list to only include annotations modified since this date (ISO8601 format)
- sortProperty string(default "id") - Property to sort by (name, modified_date, id is currently allowed)
- 'limit int(default 10) - Number of results per page
- filterByDateRange? string - Filter list to only include annotations in the specified date range with format yyyy-MM-dd'T'HH:mm:ss/yyyy-MM-dd'T'hh:MM:ss
- page int(default 0) - Page number (base 0 - first page is "0")
- locale string(default "en_US") - Locale
- expansion? ("name"|"description"|"dateRange"|"color"|"applyToAllReports"|"scope"|"createdDate"|"modifiedDate"|"modifiedById"|"owner"|"companyId"|"rsid"|"approved"|"favorite"|"shares"|"sharesFullName"|"tags"|"usageSummary"|"usageSummaryWithRelevancyScore"|"ownerFullName"|"reportSuiteName")[] - Comma-delimited list of additional annotation metadata fields to include on response
adobe.analytics: Locale
Fields
- unicodeLocaleKeys? string[] -
- country? string -
- iso3Language? string -
- displayName? string -
- language? string -
- displayVariant? string -
- iso3Country? string -
- displayLanguage? string -
- script? string -
- unicodeLocaleAttributes? string[] -
- displayCountry? string -
- variant? string -
- extensionKeys? string[] -
- displayScript? string -
adobe.analytics: NoneSettings
Fields
- includeNoneByDefault? boolean -
- noneChangeable? boolean -
adobe.analytics: Owner
Fields
- name? string - the friendly full login name of the owner, included when the expansion parameter ownerFullName is true
- id Signed32 - the login id of the owner
- login? string - the friendly full login name of the owner, included when the expansion parameter ownerFullName is true
adobe.analytics: ProjectCompatibility
Fields
- valid? boolean -
- validatorVersion? string -
- message? string -
adobe.analytics: RankedColumnError
Fields
- errorDescription? string -
- columnId? string -
- errorCode? "unauthorized_metric"|"unauthorized_dimension"|"unauthorized_dimension_global"|"anomaly_detection_failure_unexpected_item_count"|"anomaly_detection_failure_tsa_service"|"not_enabled_metric"|"not_enabled_dimension"|"not_enabled_dimension_global" -
- errorId? string -
adobe.analytics: RankedColumnMetaData
Fields
- columnIds? string[] -
- columnErrors? RankedColumnError[] -
- dimension? ReportDimension -
adobe.analytics: RankedReportData
Fields
- number? Signed32 -
- request? RankedRequest -
- firstPage? boolean -
- lastPage? boolean -
- numberOfElements? Signed32 -
- reportId? string -
- columns? RankedColumnMetaData -
- totalPages? Signed32 -
- message? string -
- rows? Row[] -
- summaryData? RankedSummaryData -
- totalElements? Signed32 -
adobe.analytics: RankedRequest
Fields
- settings? RankedSettings -
- search? ReportSearch -
- rsid? string -
- rowContainer? ReportRows -
- anchorDate? string -
- locale? Locale -
- dimension? string -
- globalFilters? ReportFilter[] -
- statistics? RankedStatistics -
- metricContainer? ReportMetrics -
adobe.analytics: RankedSettings
Fields
- includeAnomalyDetection? boolean -
- countRepeatInstances? boolean -
- dimensionSort? string -
- nonesBehavior? string -
- includeForecasting? boolean -
- 'limit? Signed32 -
- page? Signed32 -
- reflectRequest? boolean -
- includePercentChange? boolean -
- includeLatLong? boolean -
adobe.analytics: RankedStatistics
Fields
- functions? string[] -
- ignoreZeroes? boolean -
adobe.analytics: RankedSummaryData
adobe.analytics: ReportDimension
Fields
- id? string -
- 'type? "STRING"|"INT"|"DECIMAL"|"CURRENCY"|"PERCENT"|"TIME"|"ENUM"|"ORDERED_ENUM" -
adobe.analytics: ReportFilter
Fields
- itemId? string -
- segmentDefinition? AnalyticsSegmentDefinition -
- dateRange? string -
- itemIds? string[] -
- segmentId? string -
- dateRangeRelative? string -
- id? string -
- 'type? "dateRange"|"breakdown"|"segment"|"excludeItemIds" -
- excludeItemIds? string[] -
- dimension? string -
adobe.analytics: ReportMetric
Fields
- columnId? string -
- predictive? ReportMetricPredictiveSettings -
- id? string -
- filters? string[] -
- sort? string -
- metricDefinition? record { record {}... } -
adobe.analytics: ReportMetricPredictiveSettings
Fields
- anomalyConfidence? decimal -
adobe.analytics: ReportMetrics
Fields
- metrics? ReportMetric[] -
- metricFilters? ReportFilter[] -
adobe.analytics: ReportRow
Fields
- filters? string[] -
- rowId? string -
adobe.analytics: ReportRows
Fields
- rowFilters? ReportFilter[] -
- rows? ReportRow[] -
adobe.analytics: ReportSearch
Fields
- clause? string -
- includeSearchTotal? boolean -
- itemIds? string[] -
- excludeItemIds? string[] -
- empty? boolean -
adobe.analytics: ResponsePageAnalyticsAnnotation
A page of annotations
Fields
- number? Signed32 -
- lastPage? boolean -
- numberOfElements? int -
- firstPage? boolean -
- size? Signed32 -
- totalPages? Signed32 -
- sort? string -
- content? AnalyticsAnnotation[] -
- totalElements? int -
adobe.analytics: ResponsePageExpandedDateRange
A page of date ranges
Fields
- number? Signed32 -
- lastPage? boolean -
- numberOfElements? int -
- firstPage? boolean -
- size? Signed32 -
- totalPages? Signed32 -
- sort? string -
- content? ExpandedDateRange[] -
- totalElements? int -
adobe.analytics: ResponsePageUsageLogDto
Fields
- number? Signed32 -
- lastPage? boolean -
- numberOfElements? int -
- firstPage? boolean -
- size? Signed32 -
- totalPages? Signed32 -
- sort? string -
- content? UsageLogDto[] -
- totalElements? int -
adobe.analytics: Row
Fields
- dataAnomalyDetected? boolean[] -
- percentChange? decimal[] -
- dataForecastedLowerBound? decimal[] -
- data? decimal[] -
- latitude? decimal -
- dataForecasted? decimal[] -
- rowId? string -
- dataLowerBound? decimal[] -
- itemId? string -
- dataForecastedUpperBound? decimal[] -
- dataExpected? decimal[] -
- value? string -
- dataUpperBound? decimal[] -
- longitude? decimal -
adobe.analytics: RowItem
Fields
- itemId? string -
- value? string -
adobe.analytics: RunTopItemReportQueries
Represents the Queries record for the operation: runTopItemReport
Fields
- dateRange? string - Format: YYYY-MM-DD/YYYY-MM-DD
- endDate? string - Format: YYYY-MM-DD
- searchPhrase? string - A full search phrase that will be searched for
- rsid string - ID of desired report suite ie. myrsid
- locale string(default "en_US") - Locale that system named metrics should be returned in
- searchClause? string - General search string; wrap with single quotes. Example: 'PageABC'
- searchAnd? string - Search terms that will be AND-ed together. Space delimited
- lookupNoneValues boolean(default true) - Controls None values to be included
- searchNot? string - Search terms that will be treated as NOT including. Space delimited
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
- searchOr? string - Search terms that will be OR-ed together. Space delimited
- dimension string - Dimension to run the report against. Example: 'variables/page'
- startDate? string - Format: YYYY-MM-DD
adobe.analytics: SavedSharedComponent
Fields
- shares? Share[] -
- componentType? string -
- componentId? string -
adobe.analytics: SaveShareMyCompanyQueries
Represents the Queries record for the operation: saveShareMyCompany
Fields
- locale string(default "en_US") - Locale
adobe.analytics: ScopeFilter
Fields
- componentType? string -
- dimensionType? string -
- terms? string[] -
- id? string -
- operator? string -
adobe.analytics: ScopeMetric
Fields
- componentType? string -
- id? string -
adobe.analytics: SearchComponentSharesQueries
Represents the Queries record for the operation: searchComponentShares
Fields
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
- locale string(default "en_US") - Locale
- expansion? ("sharesFullName")[] - Comma-delimited list of additional project metadata fields to include on response
adobe.analytics: SearchComponentTagsQueries
Represents the Queries record for the operation: searchComponentTags
Fields
- 'limit int(default 10) - Number of results per page
- page int(default 0) - Page number (base 0 - first page is "0")
adobe.analytics: SegmentCompatibility
Fields
- valid? boolean -
- validatorVersion? string -
- supportedSchema? string[] -
- supportedFeatures? string[] -
- message? string -
- supportedProducts? string[] -
adobe.analytics: Share
Fields
- shareToId? Signed32 -
- componentType? string -
- shareToType? string -
- componentId? string -
- shareToDisplayName? string -
- shareFromImsId? string -
- accessLevel? string -
- shareToImsId? string -
- shareId? string -
- shareToLogin? string -
- imsOrgId? string -
adobe.analytics: SharedComponent
Fields
- shares? SharedToEntity[] -
- componentType? string -
- componentId? string -
adobe.analytics: SharedToEntity
Fields
- shareToId? Signed32 -
- shareToType? string -
- accessLevel? string -
- shareToImsId? string -
adobe.analytics: Tag
Tag Model
Fields
- components? TaggedComponent[] - the list of components that have been tagged with this tag
- name? string - the tag name
- description? string - the tag description
- id? Signed32 - the tag id
adobe.analytics: TaggedComponent
Fields
- componentType? string -
- componentId? string -
- tags? string[] -
adobe.analytics: UnhashReportData
Fields
- lastPage? boolean -
- reportId? string -
- searchPhrase? string -
- message? string -
- rows? RowItem[] -
- oberonRequestXML? string -
- totalElements? Signed32 -
- number? Signed32 -
- searchAnd? string -
- firstPage? boolean -
- numberOfElements? Signed32 -
- searchNot? string -
- oberonResponseXML? string -
- totalPages? Signed32 -
- searchOr? string -
adobe.analytics: UpdateAnnotationQueries
Represents the Queries record for the operation: updateAnnotation
Fields
- locale string(default "en_US") - Locale
- expansion? ("name"|"description"|"dateRange"|"color"|"applyToAllReports"|"scope"|"createdDate"|"modifiedDate"|"modifiedById"|"owner"|"companyId"|"rsid"|"approved"|"favorite"|"shares"|"sharesFullName"|"tags"|"usageSummary"|"usageSummaryWithRelevancyScore"|"ownerFullName"|"reportSuiteName")[] - Comma-delimited list of additional annotation metadata fields to include on response
adobe.analytics: UpdateCalculatedMetricQueries
Represents the Queries record for the operation: updateCalculatedMetric
Fields
- locale string(default "en_US") - Locale
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"definition"|"compatibility"|"categories")[] - Comma-delimited list of additional calculated metric metadata fields to include on response
adobe.analytics: UpdateDateRangeQueries
Represents the Queries record for the operation: updateDateRange
Fields
- locale string(default "en_US") - Locale
- newDefinition boolean(default false) - Use the new JSON def
- expansion? ("definition"|"ownerFullName"|"modified"|"approved"|"favorite"|"shares"|"tags"|"sharesFullName"|"usageSummary"|"usageSummaryWithRelevancyScore")[] - Comma-delimited list of additional date range metadata fields to include on response
adobe.analytics: UpdateProjectConfigurationQueries
Represents the Queries record for the operation: updateProjectConfiguration
Fields
- locale string(default "en_US") - Locale
- expansion? ("reportSuiteName"|"shares"|"tags"|"accessLevel"|"modified"|"externalReferences"|"definition")[] - Comma-delimited list of additional project metadata fields to include on response
adobe.analytics: UpdateSegmentQueries
Represents the Queries record for the operation: updateSegment
Fields
- locale string(default "en_US") - Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'
- expansion? ("reportSuiteName"|"ownerFullName"|"modified"|"tags"|"compatibility"|"definition"|"publishingStatus"|"definitionLastModified"|"categories")[] - Comma-delimited list of additional segment metadata fields to include on response
adobe.analytics: UpdateSharesForComponentsQueries
Represents the Queries record for the operation: updateSharesForComponents
Fields
- useCache boolean(default true) - Use caching for faster requests
- locale string(default "en_US") - Locale
adobe.analytics: UsageLogDto
Fields
- dateCreated? string -
- eventDescription? string -
- ipAddress? string -
- rsid? string -
- eventType? string -
- login? string -
adobe.analytics: ValidateCalculatedMetricQueries
Represents the Queries record for the operation: validateCalculatedMetric
Fields
- locale string(default "en_US") - Locale
- migrating boolean(default false) - Include migration functions in validation
adobe.analytics: ValidateProjectDefinitionQueries
Represents the Queries record for the operation: validateProjectDefinition
Fields
- locale string(default "en_US") - Locale
adobe.analytics: ValidateSegmentQueries
Represents the Queries record for the operation: validateSegment
Fields
- rsid string - RSID to run the report against
Import
import ballerinax/adobe.analytics;Metadata
Released date: about 23 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 46
Current verison: 1
Weekly downloads
Keywords
Vendor/Adobe
Area/Marketing & Social Media
Type/Connector
Contributors