Skip to main content
Server path: /adobe-analytics-reporting | Type: Application | PCID required: Yes

Tools

ToolDescription
adobe_analytics_reporting_calculatedmetrics_create_calculated_metricCreate a new Calculated Metric
adobe_analytics_reporting_calculatedmetrics_delete_calculated_metricDeletion of Calculated Metrics by Id
adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functionRetrieve a calculated metric function by id
adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functionsRetrieve calculated metric functions
adobe_analytics_reporting_calculatedmetrics_update_calculated_metricUpdate an existing calculated metric
adobe_analytics_reporting_calculatedmetrics_validate_calculated_metricValidate a calculated metric definition
adobe_analytics_reporting_dimensions_get_dimensionReturns a dimension for the given report suite
adobe_analytics_reporting_dimensions_get_dimensionsReturns a list of dimensions for a given report suite.
adobe_analytics_reporting_find_allRetrieves report suites that match the given filters.
adobe_analytics_reporting_find_calculated_metricsRetrieve many calculated metrics
adobe_analytics_reporting_find_oneRetrieves report suite by id
adobe_analytics_reporting_find_one_calculated_metricRetrieve a single calculated metric by id
adobe_analytics_reporting_get_metricReturns a metric for the given report suite
adobe_analytics_reporting_get_metricsReturns a list of metrics for the given report suite
adobe_analytics_reporting_run_reportRuns a report for the request in the post body
adobe_analytics_reporting_run_top_item_reportRuns a top items report for the request in the post body
adobe_analytics_reporting_segments_create_segmentCreates Segment
adobe_analytics_reporting_segments_delete_segmentDelete Segment
adobe_analytics_reporting_segments_get_segmentGet a Single Segment
adobe_analytics_reporting_segments_get_segmentsRetrieve All Segments
adobe_analytics_reporting_segments_update_segmentUpdate a Segment
adobe_analytics_reporting_segments_validate_segmentValidate a Segment

adobe_analytics_reporting_calculatedmetrics_create_calculated_metric

Create a new Calculated Metric Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale
expansionany[]NoComma-delimited list of additional calculated metric metadata fields to include on response.
categoriesany[]Nocategories
createdstringNoCalculated metric creation date
definitionobjectNodefinition
descriptionstringNodescription
idstringNoSystem generated id
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
polaritystringNoSet metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive
precisionintegerNoNumber of decimal places to include in calculated metric result
reportSuiteNamestringNoThe report suite name for which the component was created/updated
rsidstringNoThe report suite id for which the component was created/updated
siteTitlestringNositeTitle
tagsany[]Notags
typestringNotype

adobe_analytics_reporting_calculatedmetrics_delete_calculated_metric

Deletion of Calculated Metrics by Id Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe calculated metric ID to be deleted
localestringNoLocale

adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_function

Retrieve a calculated metric function by id Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe function ID to retrieve
localestringNoLocale

adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functions

Retrieve calculated metric functions Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale

adobe_analytics_reporting_calculatedmetrics_update_calculated_metric

Update an existing calculated metric Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCalculated Metric ID to be updated
localestringNoLocale
expansionany[]NoComma-delimited list of additional calculated metric metadata fields to include on response.
categoriesany[]Nocategories
createdstringNoCalculated metric creation date
definitionobjectNodefinition
descriptionstringNodescription
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
polaritystringNoSet metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive
precisionintegerNoNumber of decimal places to include in calculated metric result
reportSuiteNamestringNoThe report suite name for which the component was created/updated
rsidstringNoThe report suite id for which the component was created/updated
siteTitlestringNositeTitle
tagsany[]Notags
typestringNotype

adobe_analytics_reporting_calculatedmetrics_validate_calculated_metric

Validate a calculated metric definition Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale
migratingbooleanNoInclude migration functions in validation
categoriesany[]Nocategories
createdstringNoCalculated metric creation date
definitionobjectNodefinition
descriptionstringNodescription
idstringNoSystem generated id
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
polaritystringNoSet metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive
precisionintegerNoNumber of decimal places to include in calculated metric result
reportSuiteNamestringNoThe report suite name for which the component was created/updated
rsidstringNoThe report suite id for which the component was created/updated
siteTitlestringNositeTitle
tagsany[]Notags
typestringNotype

adobe_analytics_reporting_dimensions_get_dimension

Returns a dimension for the given report suite Parameters:
ParameterTypeRequiredDefaultDescription
dimensionIdstringYesThe dimension ID. For example a valid id is a value like ‘evar1’
rsidstringYesThe report suite ID.
localestringNoThe locale to use for returning system named dimensions.
expansionany[]NoAdd extra metadata to items (comma-delimited list)

adobe_analytics_reporting_dimensions_get_dimensions

Returns a list of dimensions for a given report suite. Parameters:
ParameterTypeRequiredDefaultDescription
rsidstringYesA Report Suite ID
localestringNoLocale
segmentablebooleanNoOnly include dimensions that are valid within a segment.
reportablebooleanNoOnly include dimensions that are valid within a report.
classifiablebooleanNoOnly include classifiable dimensions.
expansionany[]NoAdd extra metadata to items (comma-delimited list)

adobe_analytics_reporting_find_all

Retrieves report suites that match the given filters. Parameters:
ParameterTypeRequiredDefaultDescription
rsidsstringNoFilter list to only include suites in this RSID list (comma-delimited)
rsidContainsstringNoFilter list to only include suites whose rsid contains rsidContains.
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)
expansionany[]NoComma-delimited list of additional metadata fields to include on response.

adobe_analytics_reporting_find_calculated_metrics

Retrieve many calculated metrics Parameters:
ParameterTypeRequiredDefaultDescription
rsidsstringNoFilter list to only include calculated metrics tied to specified RSID list (comma-delimited)
ownerIdintegerNoFilter list to only include calculated metrics owned by the specified loginId
filterByIdsstringNoFilter 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
toBeUsedInRsidstringNoThe 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.
localestringNoLocale
namestringNoFilter list to only include calculated metrics that contains the Name
tagNamesstringNoFilter list to only include calculated metrics that contains one of the tags
favoritebooleanNoFilter list to only include calculated metrics that are favorites
approvedbooleanNoFilter list to only include calculated metrics that are approved
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)
sortDirectionstringNoSort direction (ASC or DESC)
sortPropertystringNoProperty to sort by (name, modified_date, id is currently allowed)
expansionany[]NoComma-delimited list of additional calculated metric metadata fields to include on response.
includeTypeany[]NoInclude 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:
ParameterTypeRequiredDefaultDescription
rsidstringYesThe rsid of the suite to return
expansionany[]NoComma-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:
ParameterTypeRequiredDefaultDescription
idstringYesThe calculated metric ID to retrieve
localestringNoLocale
expansionany[]NoComma-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:
ParameterTypeRequiredDefaultDescription
idstringYesThe id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews
rsidstringYesID of desired report suite ie. myrsid
localestringNoLocale that system named metrics should be returned in
expansionany[]NoAdd extra metadata to items (comma-delimited list)

adobe_analytics_reporting_get_metrics

Returns a list of metrics for the given report suite Parameters:
ParameterTypeRequiredDefaultDescription
rsidstringYesID of desired report suite ie. myrsid
localestringNoLocale that system named metrics should be returned in
segmentablebooleanNoFilter the metrics by if they are valid in a segment.
expansionany[]NoAdd extra metadata to items (comma-delimited list)

adobe_analytics_reporting_run_report

Runs a report for the request in the post body Parameters:
ParameterTypeRequiredDefaultDescription
anchorDatestringNoanchorDate
dimensionstringNodimension
globalFiltersany[]NoglobalFilters
localeobjectNolocale
metricContainerobjectNometricContainer
rowContainerobjectNorowContainer
rsidstringNorsid
searchobjectNosearch
settingsobjectNosettings
statisticsobjectNostatistics

adobe_analytics_reporting_run_top_item_report

Runs a top items report for the request in the post body Parameters:
ParameterTypeRequiredDefaultDescription
rsidstringYesID of desired report suite ie. myrsid
dimensionstringYesDimension to run the report against. Example: ‘variables/page’
localestringNoLocale that system named metrics should be returned in
dateRangestringNoFormat: YYYY-MM-DD/YYYY-MM-DD
search-clausestringNoGeneral search string; wrap with single quotes. Example: ‘PageABC’
startDatestringNoFormat: YYYY-MM-DD
endDatestringNoFormat: YYYY-MM-DD
searchAndstringNoSearch terms that will be AND-ed together. Space delimited.
searchOrstringNoSearch terms that will be OR-ed together. Space delimited.
searchNotstringNoSearch terms that will be treated as NOT including. Space delimited.
searchPhrasestringNoA full search phrase that will be searched for.
lookupNoneValuesbooleanNoControls None values to be included
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)

adobe_analytics_reporting_segments_create_segment

Creates Segment Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale
expansionany[]NoComma-delimited list of additional segment metadata fields to include on response.
categoriesany[]Nocategories
compatibilityobjectNocompatibility
createdstringNocreated
definitionobjectNodefinition
definitionLastModifiedstringNodefinitionLastModified
descriptionstringNoA description of the segment.
modifiedstringNomodified
namestringNoA name for the segment.
ownerobjectNoowner
reportSuiteNamestringNoThe friendly name for the report suite id.
rsidstringNoThe report suite id.
siteTitlestringNoA name for the report suite. This is deprecated and should use the report suite name instead.
tagsany[]NoAll existing tags associated with the segment.

adobe_analytics_reporting_segments_delete_segment

Delete Segment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe segment ID to be deleted
localestringNoLocale

adobe_analytics_reporting_segments_get_segment

Get a Single Segment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe segment ID to retrieve
localestringNoLocale
expansionany[]NoComma-delimited list of additional segment metadata fields to include on response.

adobe_analytics_reporting_segments_get_segments

Retrieve All Segments Parameters:
ParameterTypeRequiredDefaultDescription
rsidsstringNoFilter list to only include segments tied to specified RSID list (comma-delimited)
segmentFilterstringNoFilter list to only include segments in the specified list (comma-delimited list of IDs)
localestringNoLocale
namestringNoFilter list to only include segments that contains the Name
tagNamesstringNoFilter list to only include segments that contains one of the tags
filterByPublishedSegmentsstringNoFilter list to only include segments where the published field is set to one of the allowable values (all, true, false).
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)
sortDirectionstringNoSort direction (ASC or DESC
sortPropertystringNoProperty to sort by (name, modified_date, id is currently allowed)
expansionany[]NoComma-delimited list of additional segment metadata fields to include on response.
includeTypeany[]NoInclude additional segments not owned by user. The “all” option takes precedence over “shared”

adobe_analytics_reporting_segments_update_segment

Update a Segment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSegment ID to be updated
localestringNoLocale
expansionany[]NoComma-delimited list of additional segment metadata fields to include on response.
bodyobjectNoJSON-formatted Object containing key/value pairs to be updated.

adobe_analytics_reporting_segments_validate_segment

Validate a Segment Parameters:
ParameterTypeRequiredDefaultDescription
rsidstringYesRSID to run the report against
bodystringYesSegment definition