/adobe-analytics-reporting | Type: Application | PCID required: Yes
Tools
adobe_analytics_reporting_calculatedmetrics_create_calculated_metric
Create a new Calculated Metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. |
categories | any[] | No | — | categories |
created | string | No | — | Calculated metric creation date |
definition | object | No | — | definition |
description | string | No | — | description |
id | string | No | — | System generated id |
modified | string | No | — | modified |
name | string | No | — | name |
owner | object | No | — | owner |
polarity | string | No | — | Set metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive |
precision | integer | No | — | Number of decimal places to include in calculated metric result |
reportSuiteName | string | No | — | The report suite name for which the component was created/updated |
rsid | string | No | — | The report suite id for which the component was created/updated |
siteTitle | string | No | — | siteTitle |
tags | any[] | No | — | tags |
type | string | No | — | type |
adobe_analytics_reporting_calculatedmetrics_delete_calculated_metric
Deletion of Calculated Metrics by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The calculated metric ID to be deleted |
locale | string | No | — | Locale |
adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_function
Retrieve a calculated metric function by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The function ID to retrieve |
locale | string | No | — | Locale |
adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functions
Retrieve calculated metric functions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
adobe_analytics_reporting_calculatedmetrics_update_calculated_metric
Update an existing calculated metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Calculated Metric ID to be updated |
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. |
categories | any[] | No | — | categories |
created | string | No | — | Calculated metric creation date |
definition | object | No | — | definition |
description | string | No | — | description |
modified | string | No | — | modified |
name | string | No | — | name |
owner | object | No | — | owner |
polarity | string | No | — | Set metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive |
precision | integer | No | — | Number of decimal places to include in calculated metric result |
reportSuiteName | string | No | — | The report suite name for which the component was created/updated |
rsid | string | No | — | The report suite id for which the component was created/updated |
siteTitle | string | No | — | siteTitle |
tags | any[] | No | — | tags |
type | string | No | — | type |
adobe_analytics_reporting_calculatedmetrics_validate_calculated_metric
Validate a calculated metric definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
migrating | boolean | No | — | Include migration functions in validation |
categories | any[] | No | — | categories |
created | string | No | — | Calculated metric creation date |
definition | object | No | — | definition |
description | string | No | — | description |
id | string | No | — | System generated id |
modified | string | No | — | modified |
name | string | No | — | name |
owner | object | No | — | owner |
polarity | string | No | — | Set metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive |
precision | integer | No | — | Number of decimal places to include in calculated metric result |
reportSuiteName | string | No | — | The report suite name for which the component was created/updated |
rsid | string | No | — | The report suite id for which the component was created/updated |
siteTitle | string | No | — | siteTitle |
tags | any[] | No | — | tags |
type | string | No | — | type |
adobe_analytics_reporting_dimensions_get_dimension
Returns a dimension for the given report suite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dimensionId | string | Yes | — | The dimension ID. For example a valid id is a value like ‘evar1’ |
rsid | string | Yes | — | The report suite ID. |
locale | string | No | — | The locale to use for returning system named dimensions. |
expansion | any[] | No | — | Add extra metadata to items (comma-delimited list) |
adobe_analytics_reporting_dimensions_get_dimensions
Returns a list of dimensions for a given report suite. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsid | string | Yes | — | A Report Suite ID |
locale | string | No | — | Locale |
segmentable | boolean | No | — | Only include dimensions that are valid within a segment. |
reportable | boolean | No | — | Only include dimensions that are valid within a report. |
classifiable | boolean | No | — | Only include classifiable dimensions. |
expansion | any[] | No | — | Add extra metadata to items (comma-delimited list) |
adobe_analytics_reporting_find_all
Retrieves report suites that match the given filters. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsids | string | No | — | Filter list to only include suites in this RSID list (comma-delimited) |
rsidContains | string | No | — | Filter list to only include suites whose rsid contains rsidContains. |
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
expansion | any[] | No | — | Comma-delimited list of additional metadata fields to include on response. |
adobe_analytics_reporting_find_calculated_metrics
Retrieve many calculated metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsids | string | No | — | Filter list to only include calculated metrics tied to specified RSID list (comma-delimited) |
ownerId | integer | No | — | Filter list to only include calculated metrics owned by the specified loginId |
filterByIds | string | No | — | 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 |
toBeUsedInRsid | string | No | — | 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. |
locale | string | No | — | Locale |
name | string | No | — | Filter list to only include calculated metrics that contains the Name |
tagNames | string | No | — | Filter list to only include calculated metrics that contains one of the tags |
favorite | boolean | No | — | Filter list to only include calculated metrics that are favorites |
approved | boolean | No | — | Filter list to only include calculated metrics that are approved |
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
sortDirection | string | No | — | Sort direction (ASC or DESC) |
sortProperty | string | No | — | Property to sort by (name, modified_date, id is currently allowed) |
expansion | any[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. |
includeType | any[] | No | — | Include additional calculated metrics not owned by user. The “all” option takes precedence over “shared” |
adobe_analytics_reporting_find_one
Retrieves report suite by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsid | string | Yes | — | The rsid of the suite to return |
expansion | any[] | No | — | Comma-delimited list of additional metadata fields to include on response. |
adobe_analytics_reporting_find_one_calculated_metric
Retrieve a single calculated metric by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The calculated metric ID to retrieve |
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. |
adobe_analytics_reporting_get_metric
Returns a metric for the given report suite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews |
rsid | string | Yes | — | ID of desired report suite ie. myrsid |
locale | string | No | — | Locale that system named metrics should be returned in |
expansion | any[] | No | — | Add extra metadata to items (comma-delimited list) |
adobe_analytics_reporting_get_metrics
Returns a list of metrics for the given report suite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsid | string | Yes | — | ID of desired report suite ie. myrsid |
locale | string | No | — | Locale that system named metrics should be returned in |
segmentable | boolean | No | — | Filter the metrics by if they are valid in a segment. |
expansion | any[] | No | — | Add extra metadata to items (comma-delimited list) |
adobe_analytics_reporting_run_report
Runs a report for the request in the post body Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
anchorDate | string | No | — | anchorDate |
dimension | string | No | — | dimension |
globalFilters | any[] | No | — | globalFilters |
locale | object | No | — | locale |
metricContainer | object | No | — | metricContainer |
rowContainer | object | No | — | rowContainer |
rsid | string | No | — | rsid |
search | object | No | — | search |
settings | object | No | — | settings |
statistics | object | No | — | statistics |
adobe_analytics_reporting_run_top_item_report
Runs a top items report for the request in the post body Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsid | string | Yes | — | ID of desired report suite ie. myrsid |
dimension | string | Yes | — | Dimension to run the report against. Example: ‘variables/page’ |
locale | string | No | — | Locale that system named metrics should be returned in |
dateRange | string | No | — | Format: YYYY-MM-DD/YYYY-MM-DD |
search-clause | string | No | — | General search string; wrap with single quotes. Example: ‘PageABC’ |
startDate | string | No | — | Format: YYYY-MM-DD |
endDate | string | No | — | Format: YYYY-MM-DD |
searchAnd | string | No | — | Search terms that will be AND-ed together. Space delimited. |
searchOr | string | No | — | Search terms that will be OR-ed together. Space delimited. |
searchNot | string | No | — | Search terms that will be treated as NOT including. Space delimited. |
searchPhrase | string | No | — | A full search phrase that will be searched for. |
lookupNoneValues | boolean | No | — | Controls None values to be included |
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
adobe_analytics_reporting_segments_create_segment
Creates Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. |
categories | any[] | No | — | categories |
compatibility | object | No | — | compatibility |
created | string | No | — | created |
definition | object | No | — | definition |
definitionLastModified | string | No | — | definitionLastModified |
description | string | No | — | A description of the segment. |
modified | string | No | — | modified |
name | string | No | — | A name for the segment. |
owner | object | No | — | owner |
reportSuiteName | string | No | — | The friendly name for the report suite id. |
rsid | string | No | — | The report suite id. |
siteTitle | string | No | — | A name for the report suite. This is deprecated and should use the report suite name instead. |
tags | any[] | No | — | All existing tags associated with the segment. |
adobe_analytics_reporting_segments_delete_segment
Delete Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The segment ID to be deleted |
locale | string | No | — | Locale |
adobe_analytics_reporting_segments_get_segment
Get a Single Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The segment ID to retrieve |
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. |
adobe_analytics_reporting_segments_get_segments
Retrieve All Segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsids | string | No | — | Filter list to only include segments tied to specified RSID list (comma-delimited) |
segmentFilter | string | No | — | Filter list to only include segments in the specified list (comma-delimited list of IDs) |
locale | string | No | — | Locale |
name | string | No | — | Filter list to only include segments that contains the Name |
tagNames | string | No | — | Filter list to only include segments that contains one of the tags |
filterByPublishedSegments | string | No | — | Filter list to only include segments where the published field is set to one of the allowable values (all, true, false). |
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
sortDirection | string | No | — | Sort direction (ASC or DESC |
sortProperty | string | No | — | Property to sort by (name, modified_date, id is currently allowed) |
expansion | any[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. |
includeType | any[] | No | — | Include additional segments not owned by user. The “all” option takes precedence over “shared” |
adobe_analytics_reporting_segments_update_segment
Update a Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Segment ID to be updated |
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. |
body | object | No | — | JSON-formatted Object containing key/value pairs to be updated. |
adobe_analytics_reporting_segments_validate_segment
Validate a Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rsid | string | Yes | — | RSID to run the report against |
body | string | Yes | — | Segment definition |

