{ "opencollection": "1.0.0", "info": { "name": "Adobe Analytics APIs", "version": "2.0" }, "items": [ { "info": { "name": "Annotations", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all annotations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/annotations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional annotation metadata fields to include on response." }, { "name": "includeType", "value": "", "type": "query", "description": "Include additional annotations not owned by user. The \"all\" option takes precedence over \"shared\"" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "filterByIds", "value": "", "type": "query" }, { "name": "filterByModifiedAfter", "value": "", "type": "query", "description": "Filter list to only include annotations modified since this date (ISO8601 format)" }, { "name": "filterByDateRange", "value": "", "type": "query", "description": "Filter list to only include annotations in the specified date range with format yyyy-MM-dd'T'HH:mm:ss/yyyy-MM-dd'T'hh:MM:ss" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction (ASC or DESC" }, { "name": "sortProperty", "value": "", "type": "query", "description": "Property to sort by (name, modified_date, id is currently allowed)" } ] }, "docs": "Retrieve all annotations." }, { "info": { "name": "Create new annotation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/annotations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional annotation metadata fields to include on response." }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Create new annotation" }, { "info": { "name": "Get existing annotation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/annotations/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional annotation metadata fields to include on response." }, { "name": "id", "value": "", "type": "path", "description": "Annotation ID to retrieve" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Get existing annotation" }, { "info": { "name": "Update existing annotation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/annotations/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional annotation metadata fields to include on response." }, { "name": "id", "value": "", "type": "path", "description": "Annotation ID to update" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Update existing annotation" }, { "info": { "name": "Delete existing annotation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/annotations/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "Annotation ID to update" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Delete existing annotation" } ] }, { "info": { "name": "Calculated Metrics", "type": "folder" }, "items": [ { "info": { "name": "Retrieve multiple calculated metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsids", "value": "", "type": "query", "description": "Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)" }, { "name": "ownerId", "value": "", "type": "query", "description": "Filter list to only include calculated metrics owned by the specified loginId" }, { "name": "filterByIds", "value": "", "type": "query", "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" }, { "name": "toBeUsedInRsid", "value": "", "type": "query", "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." }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "name", "value": "", "type": "query", "description": "Filter list to only include calculated metrics that contains the Name" }, { "name": "tagNames", "value": "", "type": "query", "description": "Filter list to only include calculated metrics that contains one of the tags" }, { "name": "favorite", "value": "", "type": "query", "description": "Filter list to only include calculated metrics that are favorites" }, { "name": "approved", "value": "", "type": "query", "description": "Filter list to only include calculated metrics that are approved" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction (ASC or DESC)" }, { "name": "sortProperty", "value": "", "type": "query", "description": "Property to sort by (name, modified_date, id is currently allowed)" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional calculated metric metadata fields to include on response." }, { "name": "includeType", "value": "", "type": "query", "description": "Include additional calculated metrics not owned by user. The \"all\" option takes precedence over \"shared\"" } ] }, "docs": "A calculated metric response will always include these default items: *id, name, description, rsid, owner, polarity, precision, type* \n\nOther attributes can be optionally requested through the 'expansion' field:\n\n* *modified*: Date that the metric was last modified (ISO 8601)\n* *definition*: Calculated metric definition as JSON object\n* *compatibility*: Products that the metric is compatible with\n* *reportSuiteName*: Also return the friendly report suite name for the RSID\n* *tags*: Gives all exi" }, { "info": { "name": "Create a new calculated metric", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional calculated metric metadata fields to include on response." } ] }, "docs": "Creates a new calculated metric. The following attributes are available when creating a calculated metric:\n\nIMPORTANT: Required Fields: name, definition, rsid\n\nOptional fields: description\n\nExample definition for use in testing API below (\"Visits per visitor\"):\n\n```json\n\n\"definition\": {\r\n \"formula\": {\r\n \"func\": \"divide\",\r\n \"col1\": {\r\n \"func\": \"metric\",\r\n \"name\": \"metrics/visits\",\r\n \"description\": \"Visits\"\r\n },\r\n \"col2\": {\r\n \"fu" }, { "info": { "name": "Retrieve calculated metric functions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics/functions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Retrieve calculated metric functions" }, { "info": { "name": "Retrieve a calculated metric function by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics/functions/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The function ID to retrieve" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Retrieve a calculated metric function by ID" }, { "info": { "name": "Validate a calculated metric definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics/validate", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "migrating", "value": "", "type": "query", "description": "Include migration functions in validation" } ] }, "docs": "Validate a calculated metric definition" }, { "info": { "name": "Retrieve a single calculated metric by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The calculated metric ID to retrieve" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional calculated metric metadata fields to include on response." } ] }, "docs": "A calculated metric response will always include these default items: *id, name, description, rsid, owner, polarity, precision, type* \n\nOther attributes can be optionally requested through the 'expansion' field:\n\n* *modified*: Date that the metric was last modified (ISO 8601)\n* *definition*: Calculated metric definition as JSON object\n* *compatibility*: Products that the metric is compatible with\n* *reportSuiteName*: Also return the friendly report suite name for the RSID\n* *tags*: Gives all exi" }, { "info": { "name": "Update an existing calculated metric", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "Calculated Metric ID to be updated" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional calculated metric metadata fields to include on response." } ] }, "docs": "The following fields can be modified through this endpoint:
name, description, definition, owner, rsid\nExample \"defintion\" for use in testing API below (\"Visits per visitor\"):
\n\"definition\": {\r\n \"formula\": {\r\n \"func\": \"divide\",\r\n \"col1\": {\r\n \"func\": \"metric\",\r\n \"name\": \"metrics/visits\",\r\n \"description\": \"Visits\"\r\n },\r\n \"col2\": {\r\n \"func\": \"metric\",\r\n \"name\": \"metrics/visitors\",\r\n \"description\":" }, { "info": { "name": "Delete calculated metrics by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/calculatedmetrics/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The calculated metric ID to be deleted" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Delete calculated metrics by ID" } ] }, { "info": { "name": "Component Meta Data", "type": "folder" }, "items": [ { "info": { "name": "Retrieve components shared by user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "includeType", "value": "", "type": "query", "description": "Include additional shares not owned by the user" }, { "name": "userid", "value": "", "type": "query", "description": "The user ID to return details for. Only admins may use this option." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "Retrieve components shared by user" }, { "info": { "name": "Share component with user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Note that only the following component types are currently supported: \"segment\", \"project\"
There are three valid values for \"shareToType\":
\"all\": Shares the component to all users in the organization. For this operation, \"shareToId\" is not required (ignored if sent)
\"user\": Shares the component with a specific user. For this operation, \"shareToId\" (the loginId of the user to share to) is required.
\"group\": Shares the component with an entire custom user group as " }, { "info": { "name": "Update shared components with users", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "useCache", "value": "", "type": "query", "description": "Use caching for faster requests" } ] }, "docs": "Warning: Deletes and overwrites all pre-existing shares for given components. Create one/many shares for one/many components at once. For each component object in the passed list, the given shares will replace the current set of shares for each component. For example, if one of the components was previously shared with additional users, and that share is not passed in here, it will no longer be shared with them.
" }, { "info": { "name": "Create search for shared components", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares/component/search", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional project metadata fields to include on response." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "Create search for shared components" }, { "info": { "name": "Retrieve details of share by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The share ID to return details for" } ] }, "docs": "Retrieve details of share by ID" }, { "info": { "name": "Delete share by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The shareId to be deleted" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Delete by shareId and remove that share from all associated components." }, { "info": { "name": "Retrieve component IDs shared with user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/shares/sharedto/me", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "componentType", "value": "", "type": "query", "description": "ComponentType to return" } ] }, "docs": "Retrieve component IDs shared with user" }, { "info": { "name": "Create search for component tags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags/component/search", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "Create search for component tags" }, { "info": { "name": "Retrieve tags for current user company", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "Retrieve tags for current user company" }, { "info": { "name": "Create tags for current user company", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" } ] }, "docs": "Allows creation of a new tag and applies that new tag to the passed component" }, { "info": { "name": "Delete tags from components", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "componentIds", "value": "", "type": "query", "description": "Comma-separated list of componentIds to operate on." }, { "name": "componentType", "value": "", "type": "query", "description": "The component type to operate on." } ] }, "docs": "Removes all tags from the passed componentIds. Note that currently this is done in a single DB query, so there is a single combined response for the entire operation." }, { "info": { "name": "Retrieve component tags by component ID and component type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags/search", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "componentId", "value": "", "type": "query", "description": "The componentId to operate on. Currently this is just the segmentId." }, { "name": "componentType", "value": "", "type": "query", "description": "The component type to operate on." } ] }, "docs": "Given a componentId, return all tags associated with that component" }, { "info": { "name": "Update tags for component", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags/tagitems", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" } ] }, "docs": "Warning: Deletes and overwrites all pre-existing associations. This endpoint allows many tags at once to be created/deleted. Any tags passed to this endpoint will become the *only* tags for that componentId (all other tags will be removed)." }, { "info": { "name": "Retrieve tag by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "Tag ID to be retrieved" } ] }, "docs": "Retrieve tag by ID" }, { "info": { "name": "Delete tag from component", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The tagId to be deleted" } ] }, "docs": "Deletes by tag ID. This removes the tag from any or all components associated with the specified tag ID." }, { "info": { "name": "Retrieve component IDs associated with tag names", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/componentmetadata/tags/tagnames", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "tagNames", "value": "", "type": "query", "description": "Comma separated list of tag names." }, { "name": "componentType", "value": "", "type": "query", "description": "The component type to operate on." } ] }, "docs": "Given a comma separated list of tag names, return component ids associated with them." } ] }, { "info": { "name": "Date Ranges", "type": "folder" }, "items": [ { "info": { "name": "Retrieve configuration for a date range", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/dateranges/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The DateRange id for which to retrieve information" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional date range metadata fields to include on response." }, { "name": "newDefinition", "value": "", "type": "query", "description": "Use the new JSON def" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Retrieve configuration for a date range" }, { "info": { "name": "Update configuration for a date range", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/dateranges/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The DateRange id for which to retrieve information" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional date range metadata fields to include on response." }, { "name": "newDefinition", "value": "", "type": "query", "description": "Use the new JSON def" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Update configuration for a date range" }, { "info": { "name": "Delete a date range", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/dateranges/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The DateRange id for which to retrieve information" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Delete a date range" }, { "info": { "name": "Retrieve user's date ranges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/dateranges", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "includeType", "value": "", "type": "query", "description": "Include additional dateranges not owned by user. The \"all\" option takes precedence over \"shared\"" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional date range metadata fields to include on response." }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "filterByIds", "value": "", "type": "query", "description": "Filter list to only include date ranges in the specified list (comma-delimited list of IDs)" }, { "name": "newDefinition", "value": "", "type": "query", "description": "Use the new JSON def" }, { "name": "filterByModifiedAfter", "value": "", "type": "query", "description": "Filter list to only include date ranges modified since this date (ISO8601 format)" }, { "name": "curatedRsid", "value": "", "type": "query", "description": "Include the curatedItem status for given Rsid" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "This API allows users to store commonly used date ranges so that they can be reused throughout the product." }, { "info": { "name": "Create a date range", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/dateranges", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional date range metadata fields to include on response." }, { "name": "newDefinition", "value": "", "type": "query", "description": "Use the new JSON def" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Create a date range" } ] }, { "info": { "name": "Dimensions", "type": "folder" }, "items": [ { "info": { "name": "Retrieve dimensions for a report suite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/dimensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsid", "value": "", "type": "query", "description": "A report suite ID" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "segmentable", "value": "", "type": "query", "description": "Only include dimensions that are valid within a segment." }, { "name": "reportable", "value": "", "type": "query", "description": "Only include dimensions that are valid within a report." }, { "name": "classifiable", "value": "", "type": "query", "description": "Only include classifiable dimensions." }, { "name": "expansion", "value": "", "type": "query", "description": "Add extra metadata to items (comma-delimited list)" } ] }, "docs": "Retrieve dimensions for a report suite" }, { "info": { "name": "Retrieve a dimension by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/dimensions/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The dimension ID. For example a valid id is a value like 'evar1'" }, { "name": "rsid", "value": "", "type": "query", "description": "The report suite ID." }, { "name": "locale", "value": "", "type": "query", "description": "The locale to use for returning system named dimensions." }, { "name": "expansion", "value": "", "type": "query", "description": "Add extra metadata to items (comma-delimited list)" } ] }, "docs": "Retrieve a dimension by ID" } ] }, { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Retrieve metrics for a report suite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/metrics", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsid", "value": "", "type": "query", "description": "ID of desired report suite" }, { "name": "locale", "value": "", "type": "query", "description": "Locale that system named metrics should be returned in" }, { "name": "segmentable", "value": "", "type": "query", "description": "Filter the metrics by if they are valid in a segment." }, { "name": "expansion", "value": "", "type": "query", "description": "Add extra metadata to items (comma-delimited list)" } ] }, "docs": "This returns the metrics list primarily for the Analytics product. The platform identity API Returns a list of all possible metrics for the supported systems." }, { "info": { "name": "Retrieve a metric by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/metrics/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews" }, { "name": "rsid", "value": "", "type": "query", "description": "ID of desired report suite" }, { "name": "locale", "value": "", "type": "query", "description": "Locale that system named metrics should be returned in" }, { "name": "expansion", "value": "", "type": "query", "description": "Add extra metadata to items (comma-delimited list)" } ] }, "docs": "Retrieve a metric by ID" } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Retrieve project configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/projects/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The Project id for which to retrieve information" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional project metadata fields to include on response." }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Retrieve project configuration" }, { "info": { "name": "Update a project configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/projects/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The Project id for which to retrieve information" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional project metadata fields to include on response." }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Update a project configuration" }, { "info": { "name": "Delete a project", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/projects/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The Project id for which to retrieve information" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Delete a project" }, { "info": { "name": "Creates a valid project definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/projects/validate", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Creates a valid project definition" }, { "info": { "name": "Retrieve user's projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/projects", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "includeType", "value": "", "type": "query", "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" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional project metadata fields to include on response." }, { "name": "filterByIds", "value": "", "type": "query", "description": "Filter list to only include projects in the specified list (comma-delimited list of IDs)" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "pagination", "value": "", "type": "query", "description": "return paginated results" }, { "name": "ownerId", "value": "", "type": "query", "description": "Filter list to only include projects owned by the specified loginId" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "This Returns the projects list primarily for the Analytics product. " }, { "info": { "name": "Create a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/projects", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional project metadata fields to include on response." }, { "name": "locale", "value": "", "type": "query", "description": "Locale" } ] }, "docs": "Create a project" } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Create a report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/reports", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" } ] }, "docs": "For more information, see the [Reporting API guide](https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/reports/)." }, { "info": { "name": "Create a realtime report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/reports/realtime", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" } ] }, "docs": "For more information, see the [Reporting API guide](https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/reports/)." }, { "info": { "name": "Retrieve top items report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/reports/topItems", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsid", "value": "", "type": "query", "description": "ID of desired report suite ie. myrsid" }, { "name": "dimension", "value": "", "type": "query", "description": "Dimension to run the report against. Example: 'variables/page'" }, { "name": "locale", "value": "", "type": "query", "description": "Locale that system named metrics should be returned in" }, { "name": "dateRange", "value": "", "type": "query", "description": "Format: YYYY-MM-DD/YYYY-MM-DD" }, { "name": "search-clause", "value": "", "type": "query", "description": "General search string; wrap with single quotes. Example: 'PageABC'" }, { "name": "startDate", "value": "", "type": "query", "description": "Format: YYYY-MM-DD" }, { "name": "endDate", "value": "", "type": "query", "description": "Format: YYYY-MM-DD" }, { "name": "searchAnd", "value": "", "type": "query", "description": "Search terms that will be AND-ed together. Space delimited." }, { "name": "searchOr", "value": "", "type": "query", "description": "Search terms that will be OR-ed together. Space delimited." }, { "name": "searchNot", "value": "", "type": "query", "description": "Search terms that will be treated as NOT including. Space delimited." }, { "name": "searchPhrase", "value": "", "type": "query", "description": "A full search phrase that will be searched for." }, { "name": "lookupNoneValues", "value": "", "type": "query", "description": "Controls None values to be included" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "Get the top X items (based on paging restriction) for the specified dimension and rsid. Defaults to last 90 days." } ] }, { "info": { "name": "Segments", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all segments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/segments", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsids", "value": "", "type": "query", "description": "Filter list to only include segments tied to specified RSID list (comma-delimited)" }, { "name": "segmentFilter", "value": "", "type": "query", "description": "Filter list to only include segments in the specified list (comma-delimited list of IDs)" }, { "name": "locale", "value": "", "type": "query", "description": "Locale" }, { "name": "name", "value": "", "type": "query", "description": "Filter list to only include segments that contains the Name" }, { "name": "tagNames", "value": "", "type": "query", "description": "Filter list to only include segments that contains one of the tags" }, { "name": "filterByPublishedSegments", "value": "", "type": "query", "description": "Filter list to only include segments where the published field is set to one of the allowable values (all, true, false)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction (ASC or DESC" }, { "name": "sortProperty", "value": "", "type": "query", "description": "Property to sort by (name, modified_date, id is currently allowed)" }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional segment metadata fields to include on response." }, { "name": "includeType", "value": "", "type": "query", "description": "Include additional segments not owned by user. The \"all\" option takes precedence over \"shared\"" } ] }, "docs": "Retrieve all segments" }, { "info": { "name": "Create a segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/segments", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "locale", "value": "", "type": "query", "description": "Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'." }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional segment metadata fields to include on response." } ] }, "docs": "Create a segment" }, { "info": { "name": "Create validation for segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:globalCompanyId/segments/validate", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "rsid", "value": "", "type": "query", "description": "RSID to run the report against" } ] }, "docs": "Returns a segment validation for the segment contained in the post body of the report." }, { "info": { "name": "Retrieve a segment by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/segments/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The segment ID to retrieve" }, { "name": "locale", "value": "", "type": "query", "description": "Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'." }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional segment metadata fields to include on response." } ] }, "docs": "Retrieve a segment by ID" }, { "info": { "name": "Update a segment by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:globalCompanyId/segments/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "Segment ID to be updated" }, { "name": "locale", "value": "", "type": "query", "description": "Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'." }, { "name": "expansion", "value": "", "type": "query", "description": "Comma-delimited list of additional segment metadata fields to include on response." } ] }, "docs": "Update a segment by ID" }, { "info": { "name": "Delete a segment by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:globalCompanyId/segments/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "id", "value": "", "type": "path", "description": "The segment ID to be deleted" }, { "name": "locale", "value": "", "type": "query", "description": "Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'." } ] }, "docs": "Delete a segment by ID" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Retrieve users for current company", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/users", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")" } ] }, "docs": "Retrieves a list of all users for the company designated by the auth token." }, { "info": { "name": "Retrieve current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/users/me" }, "docs": "Retrieve current user" } ] }, { "info": { "name": "Usage Logs", "type": "folder" }, "items": [ { "info": { "name": "Retrieve logs for provided search criteria", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:globalCompanyId/auditlogs/usage", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" } ], "params": [ { "name": "globalCompanyId", "value": "", "type": "path", "description": "The Global Company ID for the Adobe Analytics organization" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date for the maximum of a 3 month period." }, { "name": "endDate", "value": "", "type": "query", "description": "End date for the maximum of a 3 month period." }, { "name": "login", "value": "", "type": "query", "description": "The login value of the user you want to filter logs by." }, { "name": "ip", "value": "", "type": "query", "description": "The IP address you want to filter logs by." }, { "name": "rsid", "value": "", "type": "query", "description": "The report suite ID you want to filter logs by." }, { "name": "eventType", "value": "", "type": "query", "description": "The numeric id for the event type you want to filter logs by." }, { "name": "event", "value": "", "type": "query", "description": "The event description you want to filter logs by. No wildcards permitted." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number (base 0 - first page is \"0\")." } ] }, "docs": "This API returns the usage and access logs for a given date range within a 3 month period. This API authenticates with an IMS user token." } ] } ], "bundled": true }