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

Tools

ToolDescription
adobe_analytics_management_create_date_rangeCreates configuration for a DateRange.
adobe_analytics_management_delete_date_rangeDeletes a DateRange.
adobe_analytics_management_delete_shareRemoves the shareId and all associations from that share
adobe_analytics_management_delete_tagRemoves the tagId and all associations from that tag to any components
adobe_analytics_management_delete_tag_itemsDisassociates all tags from the given components
adobe_analytics_management_find_allReturns a list of users for the current user’s login company
adobe_analytics_management_find_all_for_companyReturns a list of tags for the current user’s company
adobe_analytics_management_find_all_shares_for_companyReturns a list of shares for the current user’s company
adobe_analytics_management_get_components_by_tag_nameRetrieves component ids associated with the given tag names
adobe_analytics_management_get_current_userGet the current user
adobe_analytics_management_get_date_rangeRetrieves configuration for a DateRange.
adobe_analytics_management_get_date_rangesReturns a list of dateranges for the user
adobe_analytics_management_get_share_by_idRetrieves an share by its id
adobe_analytics_management_get_tag_by_idRetrieves an tag by its id
adobe_analytics_management_get_tag_list_by_component_id_and_component_typeRetrieves a tags for a given component by componentId and componentType
adobe_analytics_management_get_usage_access_logsRetrieves usage and access logs for the search criteria provided.
adobe_analytics_management_projects_create_projectCreates a single project.
adobe_analytics_management_projects_delete_projectdeletes a project.
adobe_analytics_management_projects_get_projectRetrieves configuration for a Project.
adobe_analytics_management_projects_get_projectsReturns a list of projects for the user
adobe_analytics_management_projects_update_projectUpdates configuration for a project.
adobe_analytics_management_projects_validate_projectValidates a Project definition
adobe_analytics_management_save_shareSaves the given share for the current user’s company
adobe_analytics_management_save_tag_component_listTag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations
adobe_analytics_management_save_tag_listSaves the given tag(s) for the current user’s company
adobe_analytics_management_search_component_sharessearch for shares for several components at once
adobe_analytics_management_search_component_tags_2search for tags for several components at once
adobe_analytics_management_shared_to_meget components shared with the current user by type
adobe_analytics_management_update_date_rangeUpdates configuration for a DateRange.
adobe_analytics_management_update_sharesShare components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components

adobe_analytics_management_create_date_range

Creates configuration for a DateRange. Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale
expansionany[]NoComma-delimited list of additional date range metadata fields to include on response.
createdstringNocreated
definitionobjectNodefinition
descriptionstringNodescription
idstringNoSystem generated id
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
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

adobe_analytics_management_delete_date_range

Deletes a DateRange. Parameters:
ParameterTypeRequiredDefaultDescription
dateRangeIdstringYesThe id of the date range to delete

adobe_analytics_management_delete_share

Removes the shareId and all associations from that share Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe shareId to be deleted

adobe_analytics_management_delete_tag

Removes the tagId and all associations from that tag to any components Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe tagId to be deleted

adobe_analytics_management_delete_tag_items

Disassociates all tags from the given components Parameters:
ParameterTypeRequiredDefaultDescription
componentIdsstringYesComma-separated list of componentIds to operate on.
componentTypestringYesThe component type to operate on.

adobe_analytics_management_find_all

Returns a list of users for the current user’s login company Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)

adobe_analytics_management_find_all_for_company

Returns a list of tags for the current user’s company Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)

adobe_analytics_management_find_all_shares_for_company

Returns a list of shares for the current user’s company Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)

adobe_analytics_management_get_components_by_tag_name

Retrieves component ids associated with the given tag names Parameters:
ParameterTypeRequiredDefaultDescription
tagNamesstringYesComma separated list of tag names.
componentTypestringYesThe component type to operate on.

adobe_analytics_management_get_current_user

Get the current user

adobe_analytics_management_get_date_range

Retrieves configuration for a DateRange. Parameters:
ParameterTypeRequiredDefaultDescription
dateRangeIdstringYesThe DateRange id for which to retrieve information
localestringNoLocale
expansionany[]NoComma-delimited list of additional date range metadata fields to include on response.

adobe_analytics_management_get_date_ranges

Returns a list of dateranges for the user Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale
filterByIdsstringNoFilter list to only include date ranges in the specified list (comma-delimited list of IDs)
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)
expansionany[]NoComma-delimited list of additional date range metadata fields to include on response.
includeTypeany[]NoInclude additional date ranges not owned by user. The “all” option takes precedence over “shared”

adobe_analytics_management_get_share_by_id

Retrieves an share by its id Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesShare ID to be retrieved

adobe_analytics_management_get_tag_by_id

Retrieves an tag by its id Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTag ID to be retrieved

adobe_analytics_management_get_tag_list_by_component_id_and_component_type

Retrieves a tags for a given component by componentId and componentType Parameters:
ParameterTypeRequiredDefaultDescription
componentIdstringYesThe componentId to operate on. Currently this is just the segmentId.
componentTypestringYesThe component type to operate on.

adobe_analytics_management_get_usage_access_logs

Retrieves usage and access logs for the search criteria provided. Parameters:
ParameterTypeRequiredDefaultDescription
startDatestringYesStart date for the maximum of a 3 month period.
endDatestringYesEnd date for the maximum of a 3 month period.
loginstringNoThe login value of the user you want to filter logs by.
ipstringNoThe IP address you want to filter logs by.
rsidstringNoThe report suite ID you want to filter logs by.
eventTypestringNoThe numeric id for the event type you want to filter logs by.
eventstringNoThe event description you want to filter logs by. No wildcards permitted.
limitintegerNoNumber of results per page.
pageintegerNoPage number (base 0 - first page is “0”).

adobe_analytics_management_projects_create_project

Creates a single project. Parameters:
ParameterTypeRequiredDefaultDescription
expansionany[]NoComma-delimited list of additional project metadata fields to include on response.
localestringNoLocale
accessLevelstringNoaccessLevel
createdstringNocreated
definitionobjectNodefinition
descriptionstringNodescription
externalReferencesobjectNoexternalReferences
idstringNoSystem generated id
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
reportSuiteNamestringNoThe report suite name for which the component was created/updated
rsidstringNoThe report suite id for which the component was created/updated
sharesany[]Noshares
tagsany[]Notags
typestringNotype
versionNotesstringNoversionNotes

adobe_analytics_management_projects_delete_project

deletes a project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe Project id for which to retrieve information
localestringNoLocale

adobe_analytics_management_projects_get_project

Retrieves configuration for a Project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe Project id for which to retrieve information
expansionany[]NoComma-delimited list of additional project metadata fields to include on response.
localestringNoLocale

adobe_analytics_management_projects_get_projects

Returns a list of projects for the user Parameters:
ParameterTypeRequiredDefaultDescription
includeTypeany[]NoInclude additional projects not owned by user. The “all” option takes precedence over “shared”. If neither guided, or project is included, both types are returned
expansionany[]NoComma-delimited list of additional project metadata fields to include on response.
filterByIdsstringNoFilter list to only include projects in the specified list (comma-delimited list of IDs)
localestringNoLocale
paginationstringNoreturn paginated results
ownerIdintegerNoFilter list to only include projects owned by the specified loginId
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)

adobe_analytics_management_projects_update_project

Updates configuration for a project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe Project id for which to retrieve information
expansionany[]NoComma-delimited list of additional project metadata fields to include on response.
localestringNoLocale
accessLevelstringNoaccessLevel
createdstringNocreated
definitionobjectNodefinition
descriptionstringNodescription
externalReferencesobjectNoexternalReferences
idstringNoSystem generated id
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
reportSuiteNamestringNoThe report suite name for which the component was created/updated
rsidstringNoThe report suite id for which the component was created/updated
sharesany[]Noshares
tagsany[]Notags
typestringNotype
versionNotesstringNoversionNotes

adobe_analytics_management_projects_validate_project

Validates a Project definition Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoLocale
projectobjectNoproject

adobe_analytics_management_save_share

Saves the given share for the current user’s company Parameters:
ParameterTypeRequiredDefaultDescription
accessLevelstringNoLevel of rights shared with entity. (for projects only)
componentIdstringNothe id of the component being shared
componentTypestringNothe type of component being shared
idintegerNothe share id
shareToDisplayNamestringNofull name of the entity shared with
shareToIdintegerNothe id of the user/group the component is shared with
shareToTypestringNothe type of entity shared with (user/group/all)

adobe_analytics_management_save_tag_component_list

Tag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations Parameters:
ParameterTypeRequiredDefaultDescription
bodyany[]NoJSON-formatted object containing key-value pairs that conform to the schema

adobe_analytics_management_save_tag_list

Saves the given tag(s) for the current user’s company Parameters:
ParameterTypeRequiredDefaultDescription
bodyany[]NoJSON-formatted array of Tag objects containing key-value pairs

adobe_analytics_management_search_component_shares

search for shares for several components at once Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)
componentIdsany[]NocomponentIds
componentTypestringNocomponentType

adobe_analytics_management_search_component_tags_2

search for tags for several components at once Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results per page
pageintegerNoPage number (base 0 - first page is “0”)
componentIdsany[]NocomponentIds
componentTypestringNocomponentType

adobe_analytics_management_shared_to_me

get components shared with the current user by type Parameters:
ParameterTypeRequiredDefaultDescription
componentTypestringYesComponent type to get shared ids for

adobe_analytics_management_update_date_range

Updates configuration for a DateRange. Parameters:
ParameterTypeRequiredDefaultDescription
dateRangeIdstringYesThe DateRange id for which to retrieve information
localestringNoLocale
expansionany[]NoComma-delimited list of additional date range metadata fields to include on response.
createdstringNocreated
definitionobjectNodefinition
descriptionstringNodescription
idstringNoSystem generated id
modifiedstringNomodified
namestringNoname
ownerobjectNoowner
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

adobe_analytics_management_update_shares

Share components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components Parameters:
ParameterTypeRequiredDefaultDescription
componentIdstringNocomponentId
componentTypestringNocomponentType
sharesany[]Noshares