adobe-analytics-reporting

Adobe Analytics Reporting - reports, segments, calculated metrics, dimensions, metrics, and report suites

Server path: /adobe-analytics-reporting | Type: Application | PCID required: Yes

Tools

Tool	Description
adobe_analytics_reporting_calculatedmetrics_create_calculated_metric	Create a new Calculated Metric
adobe_analytics_reporting_calculatedmetrics_delete_calculated_metric	Deletion of Calculated Metrics by Id
adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_function	Retrieve a calculated metric function by id
adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functions	Retrieve calculated metric functions
adobe_analytics_reporting_calculatedmetrics_update_calculated_metric	Update an existing calculated metric
adobe_analytics_reporting_calculatedmetrics_validate_calculated_metric	Validate a calculated metric definition
adobe_analytics_reporting_dimensions_get_dimension	Returns a dimension for the given report suite
adobe_analytics_reporting_dimensions_get_dimensions	Returns a list of dimensions for a given report suite.
adobe_analytics_reporting_find_all	Retrieves report suites that match the given filters.
adobe_analytics_reporting_find_calculated_metrics	Retrieve many calculated metrics
adobe_analytics_reporting_find_one	Retrieves report suite by id
adobe_analytics_reporting_find_one_calculated_metric	Retrieve a single calculated metric by id
adobe_analytics_reporting_get_metric	Returns a metric for the given report suite
adobe_analytics_reporting_get_metrics	Returns a list of metrics for the given report suite
adobe_analytics_reporting_run_report	Runs a report for the request in the post body
adobe_analytics_reporting_run_top_item_report	Runs a top items report for the request in the post body
adobe_analytics_reporting_segments_create_segment	Creates Segment
adobe_analytics_reporting_segments_delete_segment	Delete Segment
adobe_analytics_reporting_segments_get_segment	Get a Single Segment
adobe_analytics_reporting_segments_get_segments	Retrieve All Segments
adobe_analytics_reporting_segments_update_segment	Update a Segment
adobe_analytics_reporting_segments_validate_segment	Validate a Segment

---

adobe_analytics_reporting_calculatedmetrics_create_calculated_metric

Create a new Calculated Metric

Parameters:

Parameter	Type	Required	Default	Description
locale	string	No	—	Locale or language code
expansion	string[]	No	—	Comma-delimited list of additional calculated metric metadata fields to include on response.
categories	string[]	No	—	The categories value
created	string	No	—	Calculated metric creation date
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
polarity	string	No	—	Set metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive
precision	integer	No	—	Number of decimal places to include in calculated metric result
reportSuiteName	string	No	—	The report suite name for which the component was created/updated
rsid	string	No	—	The report suite id for which the component was created/updated
siteTitle	string	No	—	Site Title
tags	object[]	No	—	The tags value
type	string	No	—	The type 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": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "definition",
          "compatibility",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "definition",
        "compatibility",
        "categories"
      ]
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The categories value"
    },
    "created": {
      "type": "string",
      "description": "Calculated metric creation date"
    },
    "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"
      ]
    },
    "polarity": {
      "type": "string",
      "description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
      "enum": [
        "positive",
        "negative"
      ]
    },
    "precision": {
      "type": "integer",
      "description": "Number of decimal places to include in calculated metric result"
    },
    "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"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "CURRENCY",
        "TIME",
        "DECIMAL",
        "PERCENT"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_calculatedmetrics_delete_calculated_metric

Deletion of Calculated Metrics by Id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The calculated metric ID to be deleted
locale	string	No	—	Locale or language code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The calculated metric ID to be deleted"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_function

Retrieve a calculated metric function by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The function ID to retrieve
locale	string	No	—	Locale or language code

Show inputSchema

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

---

adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functions

Retrieve calculated metric functions

Parameters:

Parameter	Type	Required	Default	Description
locale	string	No	—	Locale or language code

Show inputSchema

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

---

adobe_analytics_reporting_calculatedmetrics_update_calculated_metric

Update an existing calculated metric

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Calculated Metric ID to be updated
locale	string	No	—	Locale or language code
expansion	string[]	No	—	Comma-delimited list of additional calculated metric metadata fields to include on response.
categories	string[]	No	—	The categories value
created	string	No	—	Calculated metric creation date
definition	object	No	—	The definition value
description	string	No	—	The description value
modified	string	No	—	The modified value
name	string	No	—	The name value
owner	object	No	—	The owner value
polarity	string	No	—	Set metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive
precision	integer	No	—	Number of decimal places to include in calculated metric result
reportSuiteName	string	No	—	The report suite name for which the component was created/updated
rsid	string	No	—	The report suite id for which the component was created/updated
siteTitle	string	No	—	Site Title
tags	object[]	No	—	The tags value
type	string	No	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Calculated Metric ID to be updated"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "definition",
          "compatibility",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "definition",
        "compatibility",
        "categories"
      ]
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The categories value"
    },
    "created": {
      "type": "string",
      "description": "Calculated metric creation date"
    },
    "definition": {
      "type": "object",
      "description": "The definition value"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "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"
      ]
    },
    "polarity": {
      "type": "string",
      "description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
      "enum": [
        "positive",
        "negative"
      ]
    },
    "precision": {
      "type": "integer",
      "description": "Number of decimal places to include in calculated metric result"
    },
    "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"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "CURRENCY",
        "TIME",
        "DECIMAL",
        "PERCENT"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_analytics_reporting_calculatedmetrics_validate_calculated_metric

Validate a calculated metric definition

Parameters:

Parameter	Type	Required	Default	Description
locale	string	No	—	Locale or language code
migrating	boolean	No	—	Include migration functions in validation
categories	string[]	No	—	The categories value
created	string	No	—	Calculated metric creation date
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
polarity	string	No	—	Set metric polarity, which indicates whether it’s good or bad if a given metric goes up. Default=positive
precision	integer	No	—	Number of decimal places to include in calculated metric result
reportSuiteName	string	No	—	The report suite name for which the component was created/updated
rsid	string	No	—	The report suite id for which the component was created/updated
siteTitle	string	No	—	Site Title
tags	object[]	No	—	The tags value
type	string	No	—	The type 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"
    },
    "migrating": {
      "type": "boolean",
      "description": "Include migration functions in validation"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The categories value"
    },
    "created": {
      "type": "string",
      "description": "Calculated metric creation date"
    },
    "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"
      ]
    },
    "polarity": {
      "type": "string",
      "description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
      "enum": [
        "positive",
        "negative"
      ]
    },
    "precision": {
      "type": "integer",
      "description": "Number of decimal places to include in calculated metric result"
    },
    "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"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "CURRENCY",
        "TIME",
        "DECIMAL",
        "PERCENT"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_dimensions_get_dimension

Returns a dimension for the given report suite

Parameters:

Parameter	Type	Required	Default	Description
dimensionId	string	Yes	—	The dimension ID. For example a valid id is a value like ‘evar1’
rsid	string	Yes	—	The report suite ID.
locale	string	No	—	The locale to use for returning system named dimensions.
expansion	string[]	No	—	Add extra metadata to items (comma-delimited list)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dimensionId": {
      "type": "string",
      "description": "The dimension ID. For example a valid id is a value like 'evar1'"
    },
    "rsid": {
      "type": "string",
      "description": "The report suite ID."
    },
    "locale": {
      "type": "string",
      "description": "The locale to use for returning system named dimensions."
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "tags",
          "shares",
          "allowedForReporting",
          "categories"
        ]
      },
      "description": "Add extra metadata to items (comma-delimited list)",
      "enum": [
        "tags",
        "shares",
        "allowedForReporting",
        "categories"
      ]
    }
  },
  "required": [
    "PCID",
    "dimensionId",
    "rsid"
  ]
}

---

adobe_analytics_reporting_dimensions_get_dimensions

Returns a list of dimensions for a given report suite.

Parameters:

Parameter	Type	Required	Default	Description
rsid	string	Yes	—	A Report Suite ID
locale	string	No	—	Locale or language code
segmentable	boolean	No	—	Only include dimensions that are valid within a segment.
reportable	boolean	No	—	Only include dimensions that are valid within a report.
classifiable	boolean	No	—	Only include classifiable dimensions.
expansion	string[]	No	—	Add extra metadata to items (comma-delimited list)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rsid": {
      "type": "string",
      "description": "A Report Suite ID"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "segmentable": {
      "type": "boolean",
      "description": "Only include dimensions that are valid within a segment.",
      "enum": [
        true
      ]
    },
    "reportable": {
      "type": "boolean",
      "description": "Only include dimensions that are valid within a report.",
      "enum": [
        true
      ]
    },
    "classifiable": {
      "type": "boolean",
      "description": "Only include classifiable dimensions.",
      "enum": [
        true
      ]
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "tags",
          "shares",
          "allowedForReporting",
          "categories"
        ]
      },
      "description": "Add extra metadata to items (comma-delimited list)",
      "enum": [
        "tags",
        "shares",
        "allowedForReporting",
        "categories"
      ]
    }
  },
  "required": [
    "PCID",
    "rsid"
  ]
}

---

adobe_analytics_reporting_find_all

Retrieves report suites that match the given filters.

Parameters:

Parameter	Type	Required	Default	Description
rsids	string	No	—	Filter list to only include suites in this RSID list (comma-delimited)
rsidContains	string	No	—	Filter list to only include suites whose rsid contains rsidContains.
limit	integer	No	—	Number of results per page
page	integer	No	—	Page number (base 0 - first page is “0”)
expansion	string[]	No	—	Comma-delimited list of additional metadata fields to include on response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rsids": {
      "type": "string",
      "description": "Filter list to only include suites in this RSID list (comma-delimited)"
    },
    "rsidContains": {
      "type": "string",
      "description": "Filter list to only include suites whose rsid contains rsidContains."
    },
    "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": [
          "name",
          "parentRsid",
          "currency",
          "calendarType",
          "timezoneZoneinfo"
        ]
      },
      "description": "Comma-delimited list of additional metadata fields to include on response.",
      "enum": [
        "name",
        "parentRsid",
        "currency",
        "calendarType",
        "timezoneZoneinfo"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_find_calculated_metrics

Retrieve many calculated metrics

Parameters:

Parameter	Type	Required	Default	Description
rsids	string	No	—	Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)
ownerId	integer	No	—	Filter list to only include calculated metrics owned by the specified loginId
filterByIds	string	No	—	Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter
toBeUsedInRsid	string	No	—	The report suite where the calculated metric intended to be used. This report suite will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved.
locale	string	No	—	Locale or language code
name	string	No	—	Filter list to only include calculated metrics that contains the Name
tagNames	string	No	—	Filter list to only include calculated metrics that contains one of the tags
favorite	boolean	No	—	Filter list to only include calculated metrics that are favorites
approved	boolean	No	—	Filter list to only include calculated metrics that are approved
limit	integer	No	—	Number of results per page
page	integer	No	—	Page number (base 0 - first page is “0”)
sortDirection	string	No	—	Sort direction (ASC or DESC)
sortProperty	string	No	—	Property to sort by (name, modified_date, id is currently allowed)
expansion	string[]	No	—	Comma-delimited list of additional calculated metric metadata fields to include on response.
includeType	string[]	No	—	Include additional calculated metrics 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"
    },
    "rsids": {
      "type": "string",
      "description": "Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)"
    },
    "ownerId": {
      "type": "integer",
      "description": "Filter list to only include calculated metrics owned by the specified loginId"
    },
    "filterByIds": {
      "type": "string",
      "description": "Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter"
    },
    "toBeUsedInRsid": {
      "type": "string",
      "description": "The report suite where the calculated metric intended to be used.  This report suite will be used to determine things like compatibility and permissions.  If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to.  If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved."
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "name": {
      "type": "string",
      "description": "Filter list to only include calculated metrics that contains the Name"
    },
    "tagNames": {
      "type": "string",
      "description": "Filter list to only include calculated metrics that contains one of the tags"
    },
    "favorite": {
      "type": "boolean",
      "description": "Filter list to only include calculated metrics that are favorites"
    },
    "approved": {
      "type": "boolean",
      "description": "Filter list to only include calculated metrics that are approved"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    },
    "sortDirection": {
      "type": "string",
      "description": "Sort direction (ASC or DESC)"
    },
    "sortProperty": {
      "type": "string",
      "description": "Property to sort by (name, modified_date, id is currently allowed)"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "definition",
          "compatibility",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "definition",
        "compatibility",
        "categories"
      ]
    },
    "includeType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "shared",
          "templates"
        ]
      },
      "description": "Include additional calculated metrics not owned by user. The \"all\" option takes precedence over \"shared\"",
      "enum": [
        "all",
        "shared",
        "templates"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_find_one

Retrieves report suite by id

Parameters:

Parameter	Type	Required	Default	Description
rsid	string	Yes	—	The rsid of the suite to return
expansion	string[]	No	—	Comma-delimited list of additional metadata fields to include on response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rsid": {
      "type": "string",
      "description": "The rsid of the suite to return"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "name",
          "parentRsid",
          "currency",
          "calendarType",
          "timezoneZoneinfo"
        ]
      },
      "description": "Comma-delimited list of additional metadata fields to include on response.",
      "enum": [
        "name",
        "parentRsid",
        "currency",
        "calendarType",
        "timezoneZoneinfo"
      ]
    }
  },
  "required": [
    "PCID",
    "rsid"
  ]
}

---

adobe_analytics_reporting_find_one_calculated_metric

Retrieve a single calculated metric by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The calculated metric ID to retrieve
locale	string	No	—	Locale or language code
expansion	string[]	No	—	Comma-delimited list of additional calculated metric metadata fields to include on response.

Show inputSchema

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

---

adobe_analytics_reporting_get_metric

Returns a metric for the given report suite

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews
rsid	string	Yes	—	ID of desired report suite ie. myrsid
locale	string	No	—	Locale that system named metrics should be returned in
expansion	string[]	No	—	Add extra metadata to items (comma-delimited list)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews"
    },
    "rsid": {
      "type": "string",
      "description": "ID of desired report suite ie. myrsid"
    },
    "locale": {
      "type": "string",
      "description": "Locale that system named metrics should be returned in"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "tags",
          "shares",
          "allowedForReporting",
          "categories"
        ]
      },
      "description": "Add extra metadata to items (comma-delimited list)",
      "enum": [
        "tags",
        "shares",
        "allowedForReporting",
        "categories"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "rsid"
  ]
}

---

adobe_analytics_reporting_get_metrics

Returns a list of metrics for the given report suite

Parameters:

Parameter	Type	Required	Default	Description
rsid	string	Yes	—	ID of desired report suite ie. myrsid
locale	string	No	—	Locale that system named metrics should be returned in
segmentable	boolean	No	—	Filter the metrics by if they are valid in a segment.
expansion	string[]	No	—	Add extra metadata to items (comma-delimited list)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rsid": {
      "type": "string",
      "description": "ID of desired report suite ie. myrsid"
    },
    "locale": {
      "type": "string",
      "description": "Locale that system named metrics should be returned in"
    },
    "segmentable": {
      "type": "boolean",
      "description": "Filter the metrics by if they are valid in a segment."
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "tags",
          "shares",
          "allowedForReporting",
          "categories"
        ]
      },
      "description": "Add extra metadata to items (comma-delimited list)",
      "enum": [
        "tags",
        "shares",
        "allowedForReporting",
        "categories"
      ]
    }
  },
  "required": [
    "PCID",
    "rsid"
  ]
}

---

adobe_analytics_reporting_run_report

Runs a report for the request in the post body

Parameters:

Parameter	Type	Required	Default	Description
anchorDate	string	No	—	Anchor Date
dimension	string	No	—	The dimension value
globalFilters	object[]	No	—	Global Filters
locale	object	No	—	Locale or language code
metricContainer	object	No	—	Metric Container
rowContainer	object	No	—	Row Container
rsid	string	No	—	The rsid value
search	object	No	—	The search value
settings	object	No	—	The settings value
statistics	object	No	—	The statistics value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "anchorDate": {
      "type": "string",
      "description": "Anchor Date"
    },
    "dimension": {
      "type": "string",
      "description": "The dimension value"
    },
    "globalFilters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "type": {
            "type": "string",
            "enum": [
              "dateRange",
              "breakdown",
              "segment",
              "excludeItemIds"
            ],
            "description": "The type value"
          },
          "dimension": {
            "type": "string",
            "description": "The dimension value"
          },
          "itemId": {
            "type": "string",
            "description": "Item Id"
          },
          "itemIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Item Ids"
          },
          "segmentId": {
            "type": "string",
            "description": "Segment Id"
          },
          "segmentDefinition": {
            "type": "object",
            "description": "Segment Definition"
          },
          "dateRange": {
            "type": "string",
            "description": "Date Range"
          },
          "excludeItemIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Exclude Item Ids"
          }
        }
      },
      "description": "Global Filters"
    },
    "locale": {
      "type": "object",
      "description": "Locale or language code",
      "properties": {
        "language": {
          "type": "string",
          "description": "The language value"
        },
        "script": {
          "type": "string",
          "description": "The script value"
        },
        "country": {
          "type": "string",
          "description": "The country value"
        },
        "variant": {
          "type": "string",
          "description": "The variant value"
        },
        "extensionKeys": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Extension Keys"
        },
        "unicodeLocaleAttributes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Unicode Locale Attributes"
        },
        "unicodeLocaleKeys": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Unicode Locale Keys"
        },
        "iso3Language": {
          "type": "string",
          "description": "Iso3 Language"
        },
        "iso3Country": {
          "type": "string",
          "description": "Iso3 Country"
        },
        "displayLanguage": {
          "type": "string",
          "description": "Display Language"
        },
        "displayScript": {
          "type": "string",
          "description": "Display Script"
        },
        "displayCountry": {
          "type": "string",
          "description": "Display Country"
        },
        "displayVariant": {
          "type": "string",
          "description": "Display Variant"
        },
        "displayName": {
          "type": "string",
          "description": "Display Name"
        }
      }
    },
    "metricContainer": {
      "type": "object",
      "description": "Metric Container",
      "properties": {
        "metricFilters": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Metric Filters"
        },
        "metrics": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The metrics value"
        }
      }
    },
    "rowContainer": {
      "type": "object",
      "description": "Row Container",
      "properties": {
        "rowFilters": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Row Filters"
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The rows value"
        }
      }
    },
    "rsid": {
      "type": "string",
      "description": "The rsid value"
    },
    "search": {
      "type": "object",
      "description": "The search value",
      "properties": {
        "clause": {
          "type": "string",
          "description": "The clause value"
        },
        "excludeItemIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Exclude Item Ids"
        },
        "itemIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Item Ids"
        },
        "includeSearchTotal": {
          "type": "boolean",
          "description": "Include Search Total"
        },
        "empty": {
          "type": "boolean",
          "description": "The empty value"
        }
      }
    },
    "settings": {
      "type": "object",
      "description": "The settings value",
      "properties": {
        "limit": {
          "type": "integer",
          "description": "Maximum number of results to return"
        },
        "page": {
          "type": "integer",
          "description": "Page number for pagination"
        },
        "dimensionSort": {
          "type": "string",
          "description": "Dimension Sort"
        },
        "countRepeatInstances": {
          "type": "boolean",
          "description": "Count Repeat Instances"
        },
        "reflectRequest": {
          "type": "boolean",
          "description": "Reflect Request"
        },
        "includeAnomalyDetection": {
          "type": "boolean",
          "description": "Include Anomaly Detection"
        },
        "includePercentChange": {
          "type": "boolean",
          "description": "Include Percent Change"
        },
        "includeLatLong": {
          "type": "boolean",
          "description": "Include Lat Long"
        },
        "nonesBehavior": {
          "type": "string",
          "description": "Nones Behavior"
        }
      }
    },
    "statistics": {
      "type": "object",
      "description": "The statistics value",
      "properties": {
        "functions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The functions value"
        },
        "ignoreZeroes": {
          "type": "boolean",
          "description": "Ignore Zeroes"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_run_top_item_report

Runs a top items report for the request in the post body

Parameters:

Parameter	Type	Required	Default	Description
rsid	string	Yes	—	ID of desired report suite ie. myrsid
dimension	string	Yes	—	Dimension to run the report against. Example: ‘variables/page’
locale	string	No	—	Locale that system named metrics should be returned in
dateRange	string	No	—	Format: YYYY-MM-DD/YYYY-MM-DD
search-clause	string	No	—	General search string; wrap with single quotes. Example: ‘PageABC’
startDate	string	No	—	Format: YYYY-MM-DD
endDate	string	No	—	Format: YYYY-MM-DD
searchAnd	string	No	—	Search terms that will be AND-ed together. Space delimited.
searchOr	string	No	—	Search terms that will be OR-ed together. Space delimited.
searchNot	string	No	—	Search terms that will be treated as NOT including. Space delimited.
searchPhrase	string	No	—	A full search phrase that will be searched for.
lookupNoneValues	boolean	No	—	Controls None values to be included
limit	integer	No	—	Number of results per page
page	integer	No	—	Page number (base 0 - first page is “0”)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rsid": {
      "type": "string",
      "description": "ID of desired report suite ie. myrsid"
    },
    "dimension": {
      "type": "string",
      "description": "Dimension to run the report against. Example: 'variables/page'"
    },
    "locale": {
      "type": "string",
      "description": "Locale that system named metrics should be returned in"
    },
    "dateRange": {
      "type": "string",
      "description": "Format: YYYY-MM-DD/YYYY-MM-DD"
    },
    "search-clause": {
      "type": "string",
      "description": "General search string; wrap with single quotes. Example: 'PageABC'"
    },
    "startDate": {
      "type": "string",
      "description": "Format: YYYY-MM-DD"
    },
    "endDate": {
      "type": "string",
      "description": "Format: YYYY-MM-DD"
    },
    "searchAnd": {
      "type": "string",
      "description": "Search terms that will be AND-ed together. Space delimited."
    },
    "searchOr": {
      "type": "string",
      "description": "Search terms that will be OR-ed together. Space delimited."
    },
    "searchNot": {
      "type": "string",
      "description": "Search terms that will be treated as NOT including. Space delimited."
    },
    "searchPhrase": {
      "type": "string",
      "description": "A full search phrase that will be searched for."
    },
    "lookupNoneValues": {
      "type": "boolean",
      "description": "Controls None values to be included"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    }
  },
  "required": [
    "PCID",
    "rsid",
    "dimension"
  ]
}

---

adobe_analytics_reporting_segments_create_segment

Creates Segment

Parameters:

Parameter	Type	Required	Default	Description
locale	string	No	—	Locale or language code
expansion	string[]	No	—	Comma-delimited list of additional segment metadata fields to include on response.
categories	string[]	No	—	The categories value
compatibility	object	No	—	The compatibility value
created	string	No	—	The created value
definition	object	No	—	The definition value
definitionLastModified	string	No	—	Definition Last Modified
description	string	No	—	A description of the segment.
modified	string	No	—	The modified value
name	string	No	—	A name for the segment.
owner	object	No	—	The owner value
reportSuiteName	string	No	—	The friendly name for the report suite id.
rsid	string	No	—	The report suite id.
siteTitle	string	No	—	A name for the report suite. This is deprecated and should use the report suite name instead.
tags	object[]	No	—	All existing tags associated with the segment.

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": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "compatibility",
          "definition",
          "publishingStatus",
          "definitionLastModified",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional segment metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "compatibility",
        "definition",
        "publishingStatus",
        "definitionLastModified",
        "categories"
      ]
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The categories value"
    },
    "compatibility": {
      "type": "object",
      "description": "The compatibility value",
      "properties": {
        "valid": {
          "type": "boolean",
          "description": "The valid value"
        },
        "message": {
          "type": "string",
          "description": "The message value"
        },
        "validator_version": {
          "type": "string",
          "description": "Validator Version"
        },
        "supported_products": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Supported Products"
        },
        "supported_schema": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Supported Schema"
        },
        "supported_features": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Supported Features"
        }
      }
    },
    "created": {
      "type": "string",
      "description": "The created value"
    },
    "definition": {
      "type": "object",
      "description": "The definition value",
      "properties": {
        "container": {
          "type": "object",
          "description": "The container value"
        },
        "func": {
          "type": "string",
          "description": "The func value"
        },
        "version": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32"
          },
          "description": "The version value"
        }
      }
    },
    "definitionLastModified": {
      "type": "string",
      "description": "Definition Last Modified"
    },
    "description": {
      "type": "string",
      "description": "A description of the segment."
    },
    "modified": {
      "type": "string",
      "description": "The modified value"
    },
    "name": {
      "type": "string",
      "description": "A name for the segment."
    },
    "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 friendly name for the report suite id."
    },
    "rsid": {
      "type": "string",
      "description": "The report suite id."
    },
    "siteTitle": {
      "type": "string",
      "description": "A name for the report suite.  This is deprecated and should use the report suite name instead."
    },
    "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": "All existing tags associated with the segment."
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_segments_delete_segment

Delete Segment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The segment ID to be deleted
locale	string	No	—	Locale or language code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The segment ID to be deleted"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_analytics_reporting_segments_get_segment

Get a Single Segment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The segment ID to retrieve
locale	string	No	—	Locale or language code
expansion	string[]	No	—	Comma-delimited list of additional segment metadata fields to include on response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The segment ID to retrieve"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "compatibility",
          "definition",
          "publishingStatus",
          "definitionLastModified",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional segment metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "compatibility",
        "definition",
        "publishingStatus",
        "definitionLastModified",
        "categories"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_analytics_reporting_segments_get_segments

Retrieve All Segments

Parameters:

Parameter	Type	Required	Default	Description
rsids	string	No	—	Filter list to only include segments tied to specified RSID list (comma-delimited)
segmentFilter	string	No	—	Filter list to only include segments in the specified list (comma-delimited list of IDs)
locale	string	No	—	Locale or language code
name	string	No	—	Filter list to only include segments that contains the Name
tagNames	string	No	—	Filter list to only include segments that contains one of the tags
filterByPublishedSegments	string	No	—	Filter list to only include segments where the published field is set to one of the allowable values (all, true, false).
limit	integer	No	—	Number of results per page
page	integer	No	—	Page number (base 0 - first page is “0”)
sortDirection	string	No	—	Sort direction (ASC or DESC
sortProperty	string	No	—	Property to sort by (name, modified_date, id is currently allowed)
expansion	string[]	No	—	Comma-delimited list of additional segment metadata fields to include on response.
includeType	string[]	No	—	Include additional segments 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"
    },
    "rsids": {
      "type": "string",
      "description": "Filter list to only include segments tied to specified RSID list (comma-delimited)"
    },
    "segmentFilter": {
      "type": "string",
      "description": "Filter list to only include segments in the specified list (comma-delimited list of IDs)"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "name": {
      "type": "string",
      "description": "Filter list to only include segments that contains the Name"
    },
    "tagNames": {
      "type": "string",
      "description": "Filter list to only include segments that contains one of the tags"
    },
    "filterByPublishedSegments": {
      "type": "string",
      "description": "Filter list to only include segments where the published field is set to one of the allowable values (all, true, false).",
      "enum": [
        "all",
        "true",
        "false"
      ]
    },
    "limit": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "page": {
      "type": "integer",
      "description": "Page number (base 0 - first page is \"0\")"
    },
    "sortDirection": {
      "type": "string",
      "description": "Sort direction (ASC or DESC"
    },
    "sortProperty": {
      "type": "string",
      "description": "Property to sort by (name, modified_date, id is currently allowed)"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "compatibility",
          "definition",
          "publishingStatus",
          "definitionLastModified",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional segment metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "compatibility",
        "definition",
        "publishingStatus",
        "definitionLastModified",
        "categories"
      ]
    },
    "includeType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "shared",
          "all",
          "templates"
        ]
      },
      "description": "Include additional segments not owned by user. The \"all\" option takes precedence over \"shared\"",
      "enum": [
        "shared",
        "all",
        "templates"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_analytics_reporting_segments_update_segment

Update a Segment

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Segment ID to be updated
locale	string	No	—	Locale or language code
expansion	string[]	No	—	Comma-delimited list of additional segment metadata fields to include on response.
body	object	No	—	JSON-formatted Object containing key/value pairs to be updated.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Segment ID to be updated"
    },
    "locale": {
      "type": "string",
      "description": "Locale or language code"
    },
    "expansion": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "reportSuiteName",
          "ownerFullName",
          "modified",
          "tags",
          "shares",
          "compatibility",
          "definition",
          "publishingStatus",
          "definitionLastModified",
          "categories"
        ]
      },
      "description": "Comma-delimited list of additional segment metadata fields to include on response.",
      "enum": [
        "reportSuiteName",
        "ownerFullName",
        "modified",
        "tags",
        "shares",
        "compatibility",
        "definition",
        "publishingStatus",
        "definitionLastModified",
        "categories"
      ]
    },
    "body": {
      "type": "object",
      "description": "JSON-formatted Object containing key/value pairs to be updated."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_analytics_reporting_segments_validate_segment

Validate a Segment

Parameters:

Parameter	Type	Required	Default	Description
rsid	string	Yes	—	RSID to run the report against
categories	string[]	No	—	The categories value
compatibility	object	No	—	The compatibility value
created	string	No	—	The created value
definition	object	No	—	The definition value
definitionLastModified	string	No	—	Definition Last Modified
description	string	No	—	A description of the segment.
modified	string	No	—	The modified value
name	string	No	—	A name for the segment.
owner	object	No	—	The owner value
reportSuiteName	string	No	—	The friendly name for the report suite id.
siteTitle	string	No	—	A name for the report suite. This is deprecated and should use the report suite name instead.
tags	object[]	No	—	All existing tags associated with the segment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "rsid": {
      "type": "string",
      "description": "RSID to run the report against"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The categories value"
    },
    "compatibility": {
      "type": "object",
      "description": "The compatibility value",
      "properties": {
        "valid": {
          "type": "boolean",
          "description": "The valid value"
        },
        "message": {
          "type": "string",
          "description": "The message value"
        },
        "validator_version": {
          "type": "string",
          "description": "Validator Version"
        },
        "supported_products": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Supported Products"
        },
        "supported_schema": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Supported Schema"
        },
        "supported_features": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Supported Features"
        }
      }
    },
    "created": {
      "type": "string",
      "description": "The created value"
    },
    "definition": {
      "type": "object",
      "description": "The definition value",
      "properties": {
        "container": {
          "type": "object",
          "description": "The container value"
        },
        "func": {
          "type": "string",
          "description": "The func value"
        },
        "version": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32"
          },
          "description": "The version value"
        }
      }
    },
    "definitionLastModified": {
      "type": "string",
      "description": "Definition Last Modified"
    },
    "description": {
      "type": "string",
      "description": "A description of the segment."
    },
    "modified": {
      "type": "string",
      "description": "The modified value"
    },
    "name": {
      "type": "string",
      "description": "A name for the segment."
    },
    "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 friendly name for the report suite id."
    },
    "siteTitle": {
      "type": "string",
      "description": "A name for the report suite.  This is deprecated and should use the report suite name instead."
    },
    "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": "All existing tags associated with the segment."
    }
  },
  "required": [
    "PCID",
    "rsid"
  ]
}