/adobe-analytics-management | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
adobe_analytics_management_create_date_range | Creates configuration for a DateRange. |
adobe_analytics_management_delete_date_range | Deletes a DateRange. |
adobe_analytics_management_delete_share | Removes the shareId and all associations from that share |
adobe_analytics_management_delete_tag | Removes the tagId and all associations from that tag to any components |
adobe_analytics_management_delete_tag_items | Disassociates all tags from the given components |
adobe_analytics_management_find_all | Returns a list of users for the current user’s login company |
adobe_analytics_management_find_all_for_company | Returns a list of tags for the current user’s company |
adobe_analytics_management_find_all_shares_for_company | Returns a list of shares for the current user’s company |
adobe_analytics_management_get_components_by_tag_name | Retrieves component ids associated with the given tag names |
adobe_analytics_management_get_current_user | Get the current user |
adobe_analytics_management_get_date_range | Retrieves configuration for a DateRange. |
adobe_analytics_management_get_date_ranges | Returns a list of dateranges for the user |
adobe_analytics_management_get_share_by_id | Retrieves an share by its id |
adobe_analytics_management_get_tag_by_id | Retrieves an tag by its id |
adobe_analytics_management_get_tag_list_by_component_id_and_component_type | Retrieves a tags for a given component by componentId and componentType |
adobe_analytics_management_get_usage_access_logs | Retrieves usage and access logs for the search criteria provided. |
adobe_analytics_management_projects_create_project | Creates a single project. |
adobe_analytics_management_projects_delete_project | deletes a project. |
adobe_analytics_management_projects_get_project | Retrieves configuration for a Project. |
adobe_analytics_management_projects_get_projects | Returns a list of projects for the user |
adobe_analytics_management_projects_update_project | Updates configuration for a project. |
adobe_analytics_management_projects_validate_project | Validates a Project definition |
adobe_analytics_management_save_share | Saves the given share for the current user’s company |
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 |
adobe_analytics_management_save_tag_list | Saves the given tag(s) for the current user’s company |
adobe_analytics_management_search_component_shares | search for shares for several components at once |
adobe_analytics_management_search_component_tags_2 | search for tags for several components at once |
adobe_analytics_management_shared_to_me | get components shared with the current user by type |
adobe_analytics_management_update_date_range | Updates configuration for a DateRange. |
adobe_analytics_management_update_shares | Share 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional date range metadata fields to include on response. |
created | string | No | — | created |
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 |
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 |
adobe_analytics_management_delete_date_range
Deletes a DateRange. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateRangeId | string | Yes | — | The id of the date range to delete |
adobe_analytics_management_delete_share
Removes the shareId and all associations from that share Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The shareId to be deleted |
adobe_analytics_management_delete_tag
Removes the tagId and all associations from that tag to any components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The tagId to be deleted |
adobe_analytics_management_delete_tag_items
Disassociates all tags from the given components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
componentIds | string | Yes | — | Comma-separated list of componentIds to operate on. |
componentType | string | Yes | — | The component type to operate on. |
adobe_analytics_management_find_all
Returns a list of users for the current user’s login company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tagNames | string | Yes | — | Comma separated list of tag names. |
componentType | string | Yes | — | The component type to operate on. |
adobe_analytics_management_get_current_user
Get the current useradobe_analytics_management_get_date_range
Retrieves configuration for a DateRange. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateRangeId | string | Yes | — | The DateRange id for which to retrieve information |
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
filterByIds | string | No | — | Filter list to only include date ranges in the specified list (comma-delimited list of IDs) |
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 date range metadata fields to include on response. |
includeType | any[] | No | — | Include 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Share ID to be retrieved |
adobe_analytics_management_get_tag_by_id
Retrieves an tag by its id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Tag 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
componentId | string | Yes | — | The componentId to operate on. Currently this is just the segmentId. |
componentType | string | Yes | — | The component type to operate on. |
adobe_analytics_management_get_usage_access_logs
Retrieves usage and access logs for the search criteria provided. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startDate | string | Yes | — | Start date for the maximum of a 3 month period. |
endDate | string | Yes | — | End date for the maximum of a 3 month period. |
login | string | No | — | The login value of the user you want to filter logs by. |
ip | string | No | — | The IP address you want to filter logs by. |
rsid | string | No | — | The report suite ID you want to filter logs by. |
eventType | string | No | — | The numeric id for the event type you want to filter logs by. |
event | string | No | — | The event description you want to filter logs by. No wildcards permitted. |
limit | integer | No | — | Number of results per page. |
page | integer | No | — | Page number (base 0 - first page is “0”). |
adobe_analytics_management_projects_create_project
Creates a single project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expansion | any[] | No | — | Comma-delimited list of additional project metadata fields to include on response. |
locale | string | No | — | Locale |
accessLevel | string | No | — | accessLevel |
created | string | No | — | created |
definition | object | No | — | definition |
description | string | No | — | description |
externalReferences | object | No | — | externalReferences |
id | string | No | — | System generated id |
modified | string | No | — | modified |
name | string | No | — | name |
owner | object | No | — | owner |
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 |
shares | any[] | No | — | shares |
tags | any[] | No | — | tags |
type | string | No | — | type |
versionNotes | string | No | — | versionNotes |
adobe_analytics_management_projects_delete_project
deletes a project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | The Project id for which to retrieve information |
locale | string | No | — | Locale |
adobe_analytics_management_projects_get_project
Retrieves configuration for a Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | The Project id for which to retrieve information |
expansion | any[] | No | — | Comma-delimited list of additional project metadata fields to include on response. |
locale | string | No | — | Locale |
adobe_analytics_management_projects_get_projects
Returns a list of projects for the user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeType | any[] | No | — | 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 |
expansion | any[] | No | — | Comma-delimited list of additional project metadata fields to include on response. |
filterByIds | string | No | — | Filter list to only include projects in the specified list (comma-delimited list of IDs) |
locale | string | No | — | Locale |
pagination | string | No | — | return paginated results |
ownerId | integer | No | — | Filter list to only include projects owned by the specified loginId |
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
adobe_analytics_management_projects_update_project
Updates configuration for a project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | The Project id for which to retrieve information |
expansion | any[] | No | — | Comma-delimited list of additional project metadata fields to include on response. |
locale | string | No | — | Locale |
accessLevel | string | No | — | accessLevel |
created | string | No | — | created |
definition | object | No | — | definition |
description | string | No | — | description |
externalReferences | object | No | — | externalReferences |
id | string | No | — | System generated id |
modified | string | No | — | modified |
name | string | No | — | name |
owner | object | No | — | owner |
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 |
shares | any[] | No | — | shares |
tags | any[] | No | — | tags |
type | string | No | — | type |
versionNotes | string | No | — | versionNotes |
adobe_analytics_management_projects_validate_project
Validates a Project definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Locale |
project | object | No | — | project |
adobe_analytics_management_save_share
Saves the given share for the current user’s company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accessLevel | string | No | — | Level of rights shared with entity. (for projects only) |
componentId | string | No | — | the id of the component being shared |
componentType | string | No | — | the type of component being shared |
id | integer | No | — | the share id |
shareToDisplayName | string | No | — | full name of the entity shared with |
shareToId | integer | No | — | the id of the user/group the component is shared with |
shareToType | string | No | — | the 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | any[] | No | — | JSON-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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | any[] | No | — | JSON-formatted array of Tag objects containing key-value pairs |
adobe_analytics_management_search_component_shares
search for shares for several components at once Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
componentIds | any[] | No | — | componentIds |
componentType | string | No | — | componentType |
adobe_analytics_management_search_component_tags_2
search for tags for several components at once Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results per page |
page | integer | No | — | Page number (base 0 - first page is “0”) |
componentIds | any[] | No | — | componentIds |
componentType | string | No | — | componentType |
adobe_analytics_management_shared_to_me
get components shared with the current user by type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
componentType | string | Yes | — | Component type to get shared ids for |
adobe_analytics_management_update_date_range
Updates configuration for a DateRange. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateRangeId | string | Yes | — | The DateRange id for which to retrieve information |
locale | string | No | — | Locale |
expansion | any[] | No | — | Comma-delimited list of additional date range metadata fields to include on response. |
created | string | No | — | created |
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 |
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 |
adobe_analytics_management_update_shares
Share components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
componentId | string | No | — | componentId |
componentType | string | No | — | componentType |
shares | any[] | No | — | shares |

