adobe-analytics-management

Adobe Analytics Management - projects, date ranges, tags, shares, users, and audit logs

Server path: /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 or language code
expansion	string[]	No	—	Comma-delimited list of additional date range metadata fields to include on response.
created	string	No	—	The created value
definition	object	No	—	The definition value
description	string	No	—	The description value
id	string	No	—	System generated id
modified	string	No	—	The modified value
name	string	No	—	The name value
owner	object	No	—	The owner value
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	—	Site Title
tags	object[]	No	—	The tags value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "definition",
          "ownerFullName",
          "modified",
          "tags"
        ]
      },
      "description": "Comma-delimited list of additional date range metadata fields to include on response.",
      "enum": [
        "definition",
        "ownerFullName",
        "modified",
        "tags"
      ]
    },
    "created": {
      "type": "string",
      "description": "The created value"
    },
    "definition": {
      "type": "object",
      "description": "The definition value"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "id": {
      "type": "string",
      "description": "System generated id"
    },
    "modified": {
      "type": "string",
      "description": "The modified value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "owner": {
      "type": "object",
      "description": "The owner value",
      "properties": {
        "id": {
          "type": "integer",
          "description": "the login id of the owner"
        },
        "name": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        },
        "login": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        }
      },
      "required": [
        "id"
      ]
    },
    "reportSuiteName": {
      "type": "string",
      "description": "The report suite name for which the component was created/updated"
    },
    "rsid": {
      "type": "string",
      "description": "The report suite id for which the component was created/updated"
    },
    "siteTitle": {
      "type": "string",
      "description": "Site Title"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "the tag id"
          },
          "name": {
            "type": "string",
            "description": "the tag name"
          },
          "description": {
            "type": "string",
            "description": "the tag description"
          },
          "components": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "componentType": {
                  "type": "string"
                },
                "componentId": {
                  "type": "string"
                },
                "tags": {
                  "type": "array"
                }
              }
            },
            "description": "the list of components that have been tagged with this tag"
          }
        }
      },
      "description": "The tags value"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateRangeId": {
      "type": "string",
      "description": "The id of the date range to delete"
    }
  },
  "required": [
    "PCID",
    "dateRangeId"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The shareId to be deleted"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The tagId to be deleted"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "componentIds": {
      "type": "string",
      "description": "Comma-separated list of componentIds to operate on."
    },
    "componentType": {
      "type": "string",
      "description": "The component type to operate on.",
      "enum": [
        "segment",
        "dashboard",
        "bookmark",
        "calculatedMetric",
        "project",
        "dateRange",
        "metric",
        "dimension",
        "virtualReportSuite",
        "scheduledJob",
        "alert",
        "classificationSet"
      ]
    }
  },
  "required": [
    "PCID",
    "componentIds",
    "componentType"
  ]
}

---

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”)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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”)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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”)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tagNames": {
      "type": "string",
      "description": "Comma separated list of tag names."
    },
    "componentType": {
      "type": "string",
      "description": "The component type to operate on.",
      "enum": [
        "segment",
        "dashboard",
        "bookmark",
        "calculatedMetric",
        "project",
        "dateRange",
        "metric",
        "dimension",
        "virtualReportSuite",
        "scheduledJob",
        "alert",
        "classificationSet"
      ]
    }
  },
  "required": [
    "PCID",
    "tagNames",
    "componentType"
  ]
}

---

adobe_analytics_management_get_current_user

Get the current user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_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 or language code
expansion	string[]	No	—	Comma-delimited list of additional date range metadata fields to include on response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateRangeId": {
      "type": "string",
      "description": "The DateRange id for which to retrieve information"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "definition",
          "ownerFullName",
          "modified",
          "tags"
        ]
      },
      "description": "Comma-delimited list of additional date range metadata fields to include on response.",
      "enum": [
        "definition",
        "ownerFullName",
        "modified",
        "tags"
      ]
    }
  },
  "required": [
    "PCID",
    "dateRangeId"
  ]
}

---

adobe_analytics_management_get_date_ranges

Returns a list of dateranges for the user

Parameters:

Parameter	Type	Required	Default	Description
locale	string	No	—	Locale or language code
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	string[]	No	—	Comma-delimited list of additional date range metadata fields to include on response.
includeType	string[]	No	—	Include additional date ranges not owned by user. The “all” option takes precedence over “shared”

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "filterByIds": {
      "type": "string",
      "description": "Filter list to only include date ranges in the specified list (comma-delimited list of IDs)"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "definition",
          "ownerFullName",
          "modified",
          "tags"
        ]
      },
      "description": "Comma-delimited list of additional date range metadata fields to include on response.",
      "enum": [
        "definition",
        "ownerFullName",
        "modified",
        "tags"
      ]
    },
    "includeType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "shared",
          "templates"
        ]
      },
      "description": "Include additional date ranges not owned by user. The \"all\" option takes precedence over \"shared\"",
      "enum": [
        "all",
        "shared",
        "templates"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Share ID to be retrieved"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Tag ID to be retrieved"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "componentId": {
      "type": "string",
      "description": "The componentId to operate on. Currently this is just the segmentId."
    },
    "componentType": {
      "type": "string",
      "description": "The component type to operate on.",
      "enum": [
        "segment",
        "dashboard",
        "bookmark",
        "calculatedMetric",
        "project",
        "dateRange",
        "metric",
        "dimension",
        "virtualReportSuite",
        "scheduledJob",
        "alert",
        "classificationSet"
      ]
    }
  },
  "required": [
    "PCID",
    "componentId",
    "componentType"
  ]
}

---

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”).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "Start date for the maximum of a 3 month period."
    },
    "endDate": {
      "type": "string",
      "description": "End date for the maximum of a 3 month period."
    },
    "login": {
      "type": "string",
      "description": "The login value of the user you want to filter logs by."
    },
    "ip": {
      "type": "string",
      "description": "The IP address you want to filter logs by."
    },
    "rsid": {
      "type": "string",
      "description": "The report suite ID you want to filter logs by."
    },
    "eventType": {
      "type": "string",
      "description": "The numeric id for the event type you want to filter logs by."
    },
    "event": {
      "type": "string",
      "description": "The event description you want to filter logs by. No wildcards permitted."
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page."
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")."
    }
  },
  "required": [
    "PCID",
    "startDate",
    "endDate"
  ]
}

---

adobe_analytics_management_projects_create_project

Creates a single project.

Parameters:

Parameter	Type	Required	Default	Description
expansion	string[]	No	—	Comma-delimited list of additional project metadata fields to include on response.
locale	string	No	—	Locale or language code
accessLevel	string	No	—	Access Level
created	string	No	—	The created value
definition	object	No	—	The definition value
description	string	No	—	The description value
externalReferences	object	No	—	External References
id	string	No	—	System generated id
modified	string	No	—	The modified value
name	string	No	—	The name value
owner	object	No	—	The owner value
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	object[]	No	—	The shares value
tags	object[]	No	—	The tags value
type	string	No	—	The type value
versionNotes	string	No	—	Version Notes

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "shares",
          "tags",
          "accessLevel",
          "modified",
          "externalReferences",
          "definition"
        ]
      },
      "description": "Comma-delimited list of additional project metadata fields to include on response."
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "accessLevel": {
      "type": "string",
      "description": "Access Level"
    },
    "created": {
      "type": "string",
      "description": "The created value"
    },
    "definition": {
      "type": "object",
      "description": "The definition value"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "externalReferences": {
      "type": "object",
      "description": "External References"
    },
    "id": {
      "type": "string",
      "description": "System generated id"
    },
    "modified": {
      "type": "string",
      "description": "The modified value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "owner": {
      "type": "object",
      "description": "The owner value",
      "properties": {
        "id": {
          "type": "integer",
          "description": "the login id of the owner"
        },
        "name": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        },
        "login": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        }
      },
      "required": [
        "id"
      ]
    },
    "reportSuiteName": {
      "type": "string",
      "description": "The report suite name for which the component was created/updated"
    },
    "rsid": {
      "type": "string",
      "description": "The report suite id for which the component was created/updated"
    },
    "shares": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The shares value"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The tags value"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "project",
        "mobileScorecard"
      ]
    },
    "versionNotes": {
      "type": "string",
      "description": "Version Notes"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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 or language code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "projectId": {
      "type": "string",
      "description": "The Project id for which to retrieve information"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    }
  },
  "required": [
    "PCID",
    "projectId"
  ]
}

---

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	string[]	No	—	Comma-delimited list of additional project metadata fields to include on response.
locale	string	No	—	Locale or language code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "projectId": {
      "type": "string",
      "description": "The Project id for which to retrieve information"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "shares",
          "tags",
          "accessLevel",
          "modified",
          "externalReferences",
          "definition"
        ]
      },
      "description": "Comma-delimited list of additional project metadata fields to include on response."
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    }
  },
  "required": [
    "PCID",
    "projectId"
  ]
}

---

adobe_analytics_management_projects_get_projects

Returns a list of projects for the user

Parameters:

Parameter	Type	Required	Default	Description
includeType	string[]	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	string[]	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 or language code
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”)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "shared"
        ]
      },
      "description": "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": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "shares",
          "tags",
          "accessLevel",
          "modified",
          "externalReferences",
          "definition"
        ]
      },
      "description": "Comma-delimited list of additional project metadata fields to include on response."
    },
    "filterByIds": {
      "type": "string",
      "description": "Filter list to only include projects in the specified list (comma-delimited list of IDs)"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "pagination": {
      "type": "string",
      "description": "return paginated results",
      "enum": [
        "true",
        "false"
      ]
    },
    "ownerId": {
      "type": "integer",
      "description": "Filter list to only include projects owned by the specified loginId"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	string[]	No	—	Comma-delimited list of additional project metadata fields to include on response.
locale	string	No	—	Locale or language code
accessLevel	string	No	—	Access Level
created	string	No	—	The created value
definition	object	No	—	The definition value
description	string	No	—	The description value
externalReferences	object	No	—	External References
id	string	No	—	System generated id
modified	string	No	—	The modified value
name	string	No	—	The name value
owner	object	No	—	The owner value
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	object[]	No	—	The shares value
tags	object[]	No	—	The tags value
type	string	No	—	The type value
versionNotes	string	No	—	Version Notes

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "projectId": {
      "type": "string",
      "description": "The Project id for which to retrieve information"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "shares",
          "tags",
          "accessLevel",
          "modified",
          "externalReferences",
          "definition"
        ]
      },
      "description": "Comma-delimited list of additional project metadata fields to include on response."
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "accessLevel": {
      "type": "string",
      "description": "Access Level"
    },
    "created": {
      "type": "string",
      "description": "The created value"
    },
    "definition": {
      "type": "object",
      "description": "The definition value"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "externalReferences": {
      "type": "object",
      "description": "External References"
    },
    "id": {
      "type": "string",
      "description": "System generated id"
    },
    "modified": {
      "type": "string",
      "description": "The modified value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "owner": {
      "type": "object",
      "description": "The owner value",
      "properties": {
        "id": {
          "type": "integer",
          "description": "the login id of the owner"
        },
        "name": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        },
        "login": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        }
      },
      "required": [
        "id"
      ]
    },
    "reportSuiteName": {
      "type": "string",
      "description": "The report suite name for which the component was created/updated"
    },
    "rsid": {
      "type": "string",
      "description": "The report suite id for which the component was created/updated"
    },
    "shares": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The shares value"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The tags value"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "project",
        "mobileScorecard"
      ]
    },
    "versionNotes": {
      "type": "string",
      "description": "Version Notes"
    }
  },
  "required": [
    "PCID",
    "projectId"
  ]
}

---

adobe_analytics_management_projects_validate_project

Validates a Project definition

Parameters:

Parameter	Type	Required	Default	Description
locale	string	No	—	Locale or language code
project	object	No	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "project": {
      "type": "object",
      "description": "The project value"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "accessLevel": {
      "type": "string",
      "description": "Level of rights shared with entity. (for projects only)"
    },
    "componentId": {
      "type": "string",
      "description": "the id of the component being shared"
    },
    "componentType": {
      "type": "string",
      "description": "the type of component being shared"
    },
    "id": {
      "type": "integer",
      "description": "the share id"
    },
    "shareToDisplayName": {
      "type": "string",
      "description": "full name of the entity shared with"
    },
    "shareToId": {
      "type": "integer",
      "description": "the id of the user/group the component is shared with"
    },
    "shareToType": {
      "type": "string",
      "description": "the type of entity shared with (user/group/all)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	object[]	Yes	—	JSON-formatted object containing key-value pairs that conform to the schema

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "componentType": {
            "type": "string",
            "description": "Component Type"
          },
          "componentId": {
            "type": "string",
            "description": "Component Id"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "the tag id"
                },
                "name": {
                  "type": "string",
                  "description": "the tag name "
                },
                "description": {
                  "type": "string",
                  "description": "the tag description"
                },
                "components": {
                  "type": "array",
                  "description": "the list of components that have been tagged with this tag"
                }
              }
            },
            "description": "The tags value"
          }
        }
      },
      "description": "JSON-formatted object containing key-value pairs that conform to the schema"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

---

adobe_analytics_management_save_tag_list

Saves the given tag(s) for the current user’s company

Parameters:

Parameter	Type	Required	Default	Description
body	object[]	Yes	—	JSON-formatted array of Tag objects containing key-value pairs

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "the tag id"
          },
          "name": {
            "type": "string",
            "description": "the tag name"
          },
          "description": {
            "type": "string",
            "description": "the tag description"
          },
          "components": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "componentType": {
                  "type": "string"
                },
                "componentId": {
                  "type": "string"
                },
                "tags": {
                  "type": "array"
                }
              }
            },
            "description": "the list of components that have been tagged with this tag"
          }
        }
      },
      "description": "JSON-formatted array of Tag objects containing key-value pairs"
    }
  },
  "required": [
    "PCID",
    "body"
  ]
}

---

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	string[]	No	—	Component Ids
componentType	string	No	—	Component Type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    },
    "componentIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Component Ids"
    },
    "componentType": {
      "type": "string",
      "description": "Component Type"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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	string[]	No	—	Component Ids
componentType	string	No	—	Component Type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    },
    "componentIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Component Ids"
    },
    "componentType": {
      "type": "string",
      "description": "Component Type"
    }
  },
  "required": [
    "PCID"
  ]
}

---

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "componentType": {
      "type": "string",
      "description": "Component type to get shared ids for"
    }
  },
  "required": [
    "PCID",
    "componentType"
  ]
}

---

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 or language code
expansion	string[]	No	—	Comma-delimited list of additional date range metadata fields to include on response.
created	string	No	—	The created value
definition	object	No	—	The definition value
description	string	No	—	The description value
id	string	No	—	System generated id
modified	string	No	—	The modified value
name	string	No	—	The name value
owner	object	No	—	The owner value
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	—	Site Title
tags	object[]	No	—	The tags value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateRangeId": {
      "type": "string",
      "description": "The DateRange id for which to retrieve information"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "definition",
          "ownerFullName",
          "modified",
          "tags"
        ]
      },
      "description": "Comma-delimited list of additional date range metadata fields to include on response.",
      "enum": [
        "definition",
        "ownerFullName",
        "modified",
        "tags"
      ]
    },
    "created": {
      "type": "string",
      "description": "The created value"
    },
    "definition": {
      "type": "object",
      "description": "The definition value"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "id": {
      "type": "string",
      "description": "System generated id"
    },
    "modified": {
      "type": "string",
      "description": "The modified value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "owner": {
      "type": "object",
      "description": "The owner value",
      "properties": {
        "id": {
          "type": "integer",
          "description": "the login id of the owner"
        },
        "name": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        },
        "login": {
          "type": "string",
          "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
        }
      },
      "required": [
        "id"
      ]
    },
    "reportSuiteName": {
      "type": "string",
      "description": "The report suite name for which the component was created/updated"
    },
    "rsid": {
      "type": "string",
      "description": "The report suite id for which the component was created/updated"
    },
    "siteTitle": {
      "type": "string",
      "description": "Site Title"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "the tag id"
          },
          "name": {
            "type": "string",
            "description": "the tag name"
          },
          "description": {
            "type": "string",
            "description": "the tag description"
          },
          "components": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "componentType": {
                  "type": "string"
                },
                "componentId": {
                  "type": "string"
                },
                "tags": {
                  "type": "array"
                }
              }
            },
            "description": "the list of components that have been tagged with this tag"
          }
        }
      },
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "dateRangeId"
  ]
}

---

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	—	Component Id
componentType	string	No	—	Component Type
shares	object[]	No	—	The shares value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "componentId": {
      "type": "string",
      "description": "Component Id"
    },
    "componentType": {
      "type": "string",
      "description": "Component Type"
    },
    "shares": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "the share id"
          },
          "shareToId": {
            "type": "integer",
            "format": "int32",
            "description": "the id of the user/group the component is shared with"
          },
          "shareToType": {
            "type": "string",
            "description": "the type of entity shared with (user/group/all)"
          },
          "shareToDisplayName": {
            "type": "string",
            "description": "full name of the entity shared with"
          },
          "componentType": {
            "type": "string",
            "description": "the type of component being shared"
          },
          "componentId": {
            "type": "string",
            "description": "the id of the component being shared"
          },
          "accessLevel": {
            "type": "string",
            "description": "Level of rights shared with entity. (for projects only)"
          }
        }
      },
      "description": "The shares value"
    }
  },
  "required": [
    "PCID"
  ]
}