Skip to content

Latest commit

 

History

History
2320 lines (1440 loc) · 67.8 KB

paths.md

File metadata and controls

2320 lines (1440 loc) · 67.8 KB
Raw

Resources

Approvals

Operations on approvals

Marks an item as approved

POST /approvals
Description

Takes an array of components and marks them all as "Approved"

Body parameter

Array containing a list of Component objects to be marked as "Approved"

Name : body
Flags : optional
Type : < Approval > array

Responses
HTTP Code Description Schema
200 successful operation Approval
400 Invalid JSON input No Content
403 Insufficient access to perform operation; only admins can approve components No Content
500 Internal Server Error; unable to create approvals for the specified components No Content
Consumes
  • application/json
Produces
  • application/json

Returns a list of approval objects for the current user. Response is paged based on the provided paging criteria.

GET /approvals
Parameters
Type Name Description Schema Default
Query limit
optional		 Number of results per page integer 10
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query userid
optional		 The user ID to return details for. Only admins may use this query parameter. integer (int32)
Responses
HTTP Code Description Schema
200 successful operation < Approval > array
400 Invalid JSON input No Content
403 Insufficient access to perform operation No Content
500 Internal Server Error; unable to retrieve approvals No Content
Produces
  • application/json

Un-approve the specified components (delete approvals)

DELETE /approvals
Description

Only Admins can create and delete approvals.

Parameters
Type Name Description Schema
Query componentIds
optional		 Comma-delimited list of componentIds for which to remove approvals string
Query componentType
required		 Type of component enum (segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classificationSet)
Responses
HTTP Code Description Schema
200 successful operation < < string, object > map > array
400 Invalid JSON input No Content
403 Insufficient access to perform operation; only admins can un-approve a segment No Content
500 Internal Server Error; unable to delete approvals for the specified components No Content
Produces
  • application/json

Retrieves an approval object by its id

GET /approvals/{id}
Parameters
Type Name Description Schema
Path id
required		 The approval ID to be returned integer (int64)
Responses
HTTP Code Description Schema
200 successful operation Approval
403 Insufficient access to perform operation No Content
404 The specified approvalId could not be found No Content
500 Internal Server Error; unable to retrieve the specified approval No Content
Produces
  • application/json

Deletes the approval with the given id

DELETE /approvals/{id}
Description

Only admins can create and delete approvals

Parameters
Type Name Description Schema
Path id
required		 The approval ID to be deleted integer (int64)
Responses
HTTP Code Description Schema
200 successful operation < string, object > map
403 Insufficient access to perform operation; user does not have access to delete the approval. No Content
404 The specified approval does not exist No Content
500 Internal Server Error; unable to delete the specified approval No Content
Produces
  • application/json

Calculatedmetrics

Create a new Calculated Metric

POST /calculatedmetrics
Description

Creates a new calculated metric. The following attributes are available when creating a calculated metric:

IMPORTANT: Required Fields: name, definition, rsid

Optional fields: description

Example definition for use in testing API below ("Page exists"):

{"definition":{},"version":[1,0,0]}

A calculated metric response will always include these default items:* id, name, description, rsid, owner*

Other attributes can be optionally requested through the 'expansion' field as defined/documented in the GET endpoints (see GET "/calculatedmetrics" or GET "/calculatedmetrics/{id}" for more documentation).

Parameters
Type Name Description Schema Default
Query expansion
optional		 Comma-delimited list of additional calculated metric metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, isDeleted, approved, favorite, shares, tags, sharesFullName, usageSummary, usageSummaryWithRelevancyScore, definition, authorization, compatibility, warning) > array(multi)
Query locale
optional		 Locale string "en_US"
Body parameter

JSON-formatted Object containing key/value pairs for calculated metric creation.

Name : body
Flags : optional
Type : AnalyticsCalculatedMetric

Responses
HTTP Code Description Schema
200 successful operation AnalyticsCalculatedMetric
400 Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object. CalculatedMetricErrorStatus
500 External API error; Calculated metric create or retrieval failed CalculatedMetricErrorStatus
Consumes
  • application/json
Produces
  • application/json

Retrieve many calculated metrics

GET /calculatedmetrics
Description

A calculated metric response will always include these default items: id, name, description, rsid, owner

Other attributes can be optionally requested through the 'expansion' field:

  • modified: Date that the metric was last modified (ISO 8601)
  • definition: Calculated metric definition as JSON object
  • compatibility: Products that the metric is compatible with
  • reportSuiteName: Also return the friendly Report Suite name for the RSID
  • favorite: True if calculated metric has been marked as a 'Favorite'
  • tags: Gives all existing tags associated with the calculated metric
  • approved: True if calculated metric has been marked as 'Approved'
  • shares: Gives all existing shares for the calculated metric
  • sharesFullName: Give 'shares', but also include the shared-to user's friendly login name as 'shareToDisplayName' in each share object
  • ownerFullName: Add friendly full login name (string) to the 'owner' object
Parameters
Type Name Description Schema Default
Query approved
optional		 Filter list to only include calculated metrics that are approved boolean
Query calculatedMetricFilter
optional		 Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) string
Query expansion
optional		 Comma-delimited list of additional calculated metric metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, isDeleted, approved, favorite, shares, tags, sharesFullName, usageSummary, usageSummaryWithRelevancyScore, definition, authorization, compatibility, warning) > array(multi)
Query favorite
optional		 Filter list to only include calculated metrics that are favorites boolean
Query filterByIds
optional		 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 string
Query filterByModifiedAfter
optional		 Filter list to only include calculated metrics modified since this date (ISO8601 format) string
Query limit
optional		 Number of results per page integer 10
Query locale
optional		 Locale string "en_US"
Query name
optional		 Filter list to only include calculated metrics that contains the Name string
Query ownerId
optional		 Filter list to only include calculated metrics owned by the specified loginId integer (int32)
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query pagination
optional		 return paginated results enum (true, false) "false"
Query rsids
optional		 Filter list to only include calculated metrics tied to specified RSID list (comma-delimited) string
Query tagNames
optional		 Filter list to only include calculated metrics that contains one of the tags string
Responses
HTTP Code Description Schema
200 successful operation < AnalyticsCalculatedMetric > array
400 Unable to retrieve list of calculated metrics shared with user CalculatedMetricErrorStatus
401 Owner filter error; user specified is not in the same company as the requesting user CalculatedMetricErrorStatus
403 Requesting non-shared calculated metrics for other users is restricted to admin users CalculatedMetricErrorStatus
500 External API error; Calculated metric retrieval failed CalculatedMetricErrorStatus
Produces
  • application/json

Retrieve calculated metric functions

GET /calculatedmetrics/functions
Parameters
Type Name Description Schema Default
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation < CalcMetricFunction > array
500 External API error; Calculated metric functions retrieval failed CalculatedMetricErrorStatus
Produces
  • application/json

Retrieve a calculated metric function by id

GET /calculatedmetrics/functions/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The function ID to retrieve string
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation CalcMetricFunction
404 Calculated metric function not found CalculatedMetricErrorStatus
500 External API error; Calculated metric function retrieval failed CalculatedMetricErrorStatus
Produces
  • application/json

Retrieve a single calculated metric by id

GET /calculatedmetrics/{id}
Description

A calculated metric response will always include these default items: id, name, description, rsid, owner

Other attributes can be optionally requested through the 'expansion' field:

  • modified: Date that the metric was last modified (ISO 8601)
  • definition: Calculated metric definition as JSON object
  • compatibility: Products that the metric is compatible with
  • reportSuiteName: Also return the friendly Report Suite name for the RSID
  • favorite: True if calculated metric has been marked as a 'Favorite'
  • tags: Gives all existing tags associated with the calculated metric
  • approved: True if calculated metric has been marked as 'Approved'
  • shares: Gives all existing shares for the calculated metric
  • sharesFullName: Give 'shares', but also include the shared-to user's friendly login name as 'shareToDisplayName' in each share object
  • ownerFullName: Add friendly full login name (string) to the 'owner' object
Parameters
Type Name Description Schema Default
Path id
required		 The calculated metric ID to retrieve string
Query expansion
optional		 Comma-delimited list of additional calculated metric metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, isDeleted, approved, favorite, shares, tags, sharesFullName, usageSummary, usageSummaryWithRelevancyScore, definition, authorization, compatibility, warning) > array(multi)
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation AnalyticsCalculatedMetric
403 Requesting non-shared calculated metrics for other users is restricted to admin users CalculatedMetricErrorStatus
500 External API error; calculated metric retrieval failed CalculatedMetricErrorStatus
Produces
  • application/json

Update an existing calculated metric

PUT /calculatedmetrics/{id}
Description

The following fields can be modified through this endpoint:
name, description, definition, owner, rsidExample "defintion" for use in testing API below ("Page exists"):
"definition":{},"version":[1,0,0]}

Response will be the newly modified calculated metric object after the update request completes.

CalculatedMetricResponse
A calculated metric response will always include these default items:* id, name, description, rsid, owner*

Other attributes can be optionally requested through the 'expansion' field as defined/documented in the GET endpoints (see GET "/calculatedmetrics" or GET "/calculatedmetrics/{id}" for more documentation).

Parameters
Type Name Description Schema Default
Path id
required		 Calculated Metric ID to be updated string
Query expansion
optional		 Comma-delimited list of additional calculated metric metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, isDeleted, approved, favorite, shares, tags, sharesFullName, usageSummary, usageSummaryWithRelevancyScore, definition, authorization, compatibility, warning) > array(multi)
Query locale
optional		 Locale string "en_US"
Body parameter

JSON-formatted Object containing key/value pairs to be updated.

Name : body
Flags : optional
Type : AnalyticsCalculatedMetric

Responses
HTTP Code Description Schema
200 successful operation AnalyticsCalculatedMetric
400 Definition must be formatted as a JSON Object CalculatedMetricErrorStatus
401 Company mismatch; calculated metric ownership can only be transferred within the same organization CalculatedMetricErrorStatus
403 User does not have permission to update this calculated metric CalculatedMetricErrorStatus
500 External API error; Calculated metric update or retrieval failed CalculatedMetricErrorStatus
Consumes
  • application/json
Produces
  • application/json

Deletion of Calculated Metrics by Id

DELETE /calculatedmetrics/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The calculated metric ID to be deleted string
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation DeleteResponse
500 External API error; Calculated metric delete failed CalculatedMetricErrorStatus
Produces
  • application/json

Classifications

Creates a classification set.

POST /classifications/dataset
Responses
HTTP Code Description Schema
200 successful operation ClassificationSet
Produces
  • application/json

Retrieves all classification sets.

GET /classifications/dataset
Parameters
Type Name Description Schema
Query limit
optional		 Documents per page integer (int32)
Query page
optional		 Page integer (int32)
Query sortField
optional		 Sort field enum (name, modified, created)
Query sortOrder
optional		 Sort order enum (asc, desc)
Responses
HTTP Code Description Schema
200 successful operation < ClassificationSet > array
Produces
  • application/json

Retrieves classification sets based on search criteria.

POST /classifications/dataset/search
Parameters
Type Name Description Schema
Query limit
optional		 Documents per page integer (int32)
Query page
optional		 Page integer (int32)
Query sortField
optional		 Sort field enum (name, modified, created)
Query sortOrder
optional		 Sort order enum (asc, desc)
Body parameter

JSON-formatted Object containing key/value pairs for search.

Name : body
Flags : optional
Type : ClassificationSetFilterArgs

Responses
HTTP Code Description Schema
200 successful operation < ClassificationSet > array
Produces
  • application/json

Retrieves a single classification set.

GET /classifications/dataset/{id}
Parameters
Type Name Description Schema
Path id
required		 The id for which to retrieve information string
Responses
HTTP Code Description Schema
200 successful operation ClassificationSet
Produces
  • application/json

Updates a classification set.

PUT /classifications/dataset/{id}
Parameters
Type Name Description Schema
Path id
required		 The id for the classification set to update string
Responses
HTTP Code Description Schema
200 successful operation ClassificationSet
Produces
  • application/json

Deletes a classification set.

DELETE /classifications/dataset/{id}
Parameters
Type Name Description Schema
Path id
required		 The id for the classification set to delete string
Responses
HTTP Code Description Schema
200 successful operation ClassificationSet
Produces
  • application/json

Creates an export job for a classification set.

POST /classifications/dataset/{id}/export
Parameters
Type Name Description Schema
Path id
required		 The id for the classification set for which to import data string
Body parameter

Job export options

Name : body
Flags : optional
Type : JobExportOptions

Responses
HTTP Code Description Schema
200 successful operation ClassificationJob
Produces
  • application/json

Retrieves classification jobs.

GET /classifications/jobs
Parameters
Type Name Description Schema
Query datasetId
optional		 ClassificationSetId filter string
Query limit
optional		 Documents per page (minimum limit is 10) integer (int32)
Query page
optional		 Page integer (int32)
Query sortField
optional		 Sort field enum (type, name)
Query sortOrder
optional		 Sort order enum (asc, desc)
Responses
HTTP Code Description Schema
200 successful operation < ClassificationJob > array
Produces
  • application/json

Retrieves a single classification job.

GET /classifications/jobs/{id}
Parameters
Type Name Description Schema
Path id
required		 The job id for which to retrieve information string
Responses
HTTP Code Description Schema
200 successful operation ClassificationJob
Produces
  • application/json

Retrieves info about the first artifact for a given job id.

GET /classifications/jobs/{id}/artifact
Parameters
Type Name Description Schema
Path id
required		 The job id for which to retrieve information string
Responses
HTTP Code Description Schema
200 successful operation JobArtifactResponse
Produces
  • application/json

Retrieves the artifact for a given job and artifact id.

GET /classifications/jobs/{id}/artifact/{artifactId}
Parameters
Type Name Description Schema
Path artifactId
required		 The artifact id for which to retrieve information string
Path id
required		 The job id for which to retrieve information string
Responses
HTTP Code Description Schema
default successful operation No Content

Runs an oberon report to get unclassifed values for the given classification set.

GET /classifications/unclassified/{classificationSetId}
Parameters
Type Name Description Schema Default
Path classificationSetId
required		 The id for which to retrieve information string
Query allowRemoteLoad
optional		 Controls if Oberon should remote load data. Default behavior is true with fallback to false if remote data does not exist enum (true, false, default) "default"
Query dateRange
optional		 Format: YYYY-MM-DD/YYYY-MM-DD string
Query dimension
required		 Dimension to run the report against string
Query endDate
optional		 Format: YYYY-MM-DD string
Query includeOberonXml
optional		 Controls if Oberon XML should be returned in the response - DEBUG ONLY enum (true, false) "false"
Query rsid
required		 RSID to run the report against string
Query startDate
optional		 Format: YYYY-MM-DD string
Responses
HTTP Code Description Schema
200 successful operation RankedReportData
Produces
  • application/json

Collections

Analytics Collections

Retrieves report suites that match the given filters.

GET /collections/suites
Parameters
Type Name Description Schema Default
Query expansion
optional		 Comma-delimited list of additional metadata fields to include on response. < enum (name, parentRsid, numGroups, currency, calendarType, currentTimezoneOffset, timezoneZoneinfo) > array(multi)
Query limit
optional		 Number of results per page integer 10
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query rsidContains
optional		 Filter list to only include suites whose rsid contains rsidContains. string
Query rsids
optional		 Filter list to only include suites in this RSID list (comma-delimited) string
Query userGroupId
optional		 Filter list to only include suites that are in the given userGroupId integer (int32)
Responses
HTTP Code Description Schema
200 successful operation SuiteCollectionItem
500 Unexpected error; report suite retrieval failed No Content
Produces
  • application/json

Retrieves report suite by id

GET /collections/suites/{rsid}
Parameters
Type Name Description Schema
Path rsid
required		 The rsid of the suite to return string
Query expansion
optional		 Comma-delimited list of additional metadata fields to include on response. < enum (name, parentRsid, numGroups, currency, calendarType, currentTimezoneOffset, timezoneZoneinfo) > array(multi)
Responses
HTTP Code Description Schema
200 successful operation SuiteCollectionItem
500 Unexpected error; report suite retrieval failed No Content
Produces
  • application/json

Companies

Analytics Company Service

Retrieves information about the login company for the current user.

GET /companies/me
Parameters
Type Name Description Schema
Query expansion
optional		 Comma-delimited list of company expansions. < enum (validEmails, allowAdobeEmails, companySecurity, billingTabAccess) > array(multi)
Responses
HTTP Code Description Schema
200 successful operation Company
500 Unexpected error; company retrieval failed No Content
Produces
  • application/json

Retrieves the tracking server for the login company of the current user.

GET /companies/me/trackingserver
Parameters
Type Name Description Schema
Query rsid
required		 The rsid to use if this company does not require namespace use. string
Responses
HTTP Code Description Schema
200 successful operation AnalyticsTrackingServer
500 Unexpected error; tracking server retrieval failed No Content
Produces
  • application/json

Dimensions

Dimensions service

Returns a list of dimensions for a given report suite.

GET /dimensions
Parameters
Type Name Description Schema Default
Query classifiable
optional		 Only include classifiable dimensions. enum (true)
Query dataGovernanceLabels
optional		 Filter the response based on data governance labels. Search for multiple lables using a comma-delimited string format. Any metric/dimension containing one or more of the provided labels will be returned. < string > array(multi)
Query dataGovernanceNamespaces
optional		 Filter the response based on data governance namespaces. Search for multiple namespaces using a comma-delimited string format. Any dimension containing one or more of the provided namespaces will be returned. < string > array(multi)
Query expansion
optional		 Add extra metadata to items (comma-delimited list) < enum (tags, approved, favorite, usageSummary, attributes) > array(multi)
Query locale
optional		 Locale string "en_US"
Query reportTimeAttribution
optional		 Only include dimensions that support reportTimeAttribution. enum (true)
Query reportable
optional		 Only include dimensions that are valid within a report. enum (true)
Query rsid
required		 A Report Suite ID string
Query segmentable
optional		 Only include dimensions that are valid within a segment. enum (true)
Query support
optional		 Comma-delimited list of products to filter the dimension list by. Possible values are 'oberon' and 'dataWarehouse'. < enum (oberon, dataWarehouse) > array(multi)
Query supportsDataGovernance
optional		 Only include dimensions that contain dataGovernance attribute. enum (true)
Query useCache
optional		 Enable caching for faster requests. boolean "true"
Responses
HTTP Code Description Schema
200 successful operation < AnalyticsDimension > array
400 Invalid JSON input No Content
401 User does not have access to this report suite No Content
500 Unexpected internal server error No Content
Produces
  • application/json

Get all gdpr namespaces for a user's ims org

GET /dimensions/datagovernance/namespaces
Parameters
Type Name Description Schema Default
Query useCache
optional		 Enable caching boolean "true"
Responses
HTTP Code Description Schema
200 Success status < string > array
Produces
  • application/json

Returns the names of the dimension items listed in the post body.

POST /dimensions/values
Description

Given a dimension name and an itemId, this endpoint returns the text value for that itemId

Parameters
Type Name Description Schema Default
Query dateRange
optional		 Optionally supply the date range for filtering dimension values (default is last 90 days). Example format: 2014-06-01/2014-06-30 (gives June 2014) string
Query locale
optional		 Locale to use when returning dimension information. string "en_US"
Query rsid
required		 The report suite ID string
Body parameter

Array of dimensionItem objects where each element contains key-value pairs for "dimension" and "itemId"

Name : body
Flags : required
Type : < DimensionItem > array

Responses
HTTP Code Description Schema
200 successful operation < DimensionItem > array
400 Invalid JSON input No Content
403 Insufficient access to perform operation No Content
500 Unexpected internal server error No Content
Produces
  • application/json

Returns a dimension for the given report suite

GET /dimensions/{dimensionId}
Parameters
Type Name Description Schema Default
Path dimensionId
required		 The dimension ID. For example a valid id is a value like 'evar1' string
Query expansion
optional		 Add extra metadata to items (comma-delimited list) < enum (tags, approved, favorite, usageSummary, attributes) > array(multi)
Query locale
optional		 The locale to use for returning system named dimensions. string "en_US"
Query rsid
required		 The report suite ID. string
Responses
HTTP Code Description Schema
200 successful operation AnalyticsDimension
401 User Doesn't have sufficient privileges No Content
Produces
  • application/json

Favorites

Operations on managing favorites on components

Creates 'favorite' records for a given component

POST /favorites
Description

Accepts an array of Favorite objects to allow creation of one or many 'favorite' records in a single call.

Body parameter

JSON-formatted ARRAY containing a list of favorite objects

Name : body
Flags : required
Type : < Favorite > array

Responses
HTTP Code Description Schema
200 successful operation Favorite
Consumes
  • application/json
Produces
  • application/json

Returns a list of favorite objects for the current user meeting the paging restriction

GET /favorites
Description

Returns an array of all of the favorites objects tied to the company. Setting a very large page size will return the list in a single request, but it may be more data than you expect and you may experience performance issues.

Parameters
Type Name Description Schema Default
Query componentIds
optional		 Comma-delimited list of componentIds to filter on. Must also pass componentType. string
Query componentType
optional		 The component type to filter on. Required if also using componentIds filter. enum (segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classificationSet)
Query limit
optional		 Number of results per page integer 10
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query userid
optional		 The user ID to return details for. Only admins may use this option. integer (int32)
Responses
HTTP Code Description Schema
200 successful operation < Favorite > array
Produces
  • application/json

Deletes favorites by componentId. Accepts a list of componentIds and deletes any "Favorites" associated with them

DELETE /favorites
Description

Deletes favorites based on componentIds.

Parameters
Type Name Description Schema
Query componentIds
required		 A comma separated list of component Ids string
Query componentType
required		 The component type to operate on. enum (segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classificationSet)
Responses
HTTP Code Description Schema
200 successful operation < < string, object > map > array
Produces
  • application/json

Retrieve a 'favorite' record by id

GET /favorites/{id}
Parameters
Type Name Description Schema
Path id
required		 The id of the "Favorite" record to return integer (int64)
Responses
HTTP Code Description Schema
200 successful operation Favorite
Produces
  • application/json

Deletes the "Favorite" with the given id

DELETE /favorites/{id}
Description

Deletes by favoriteId.

Parameters
Type Name Description Schema
Path id
required		 The id of the favorite integer (int64)
Responses
HTTP Code Description Schema
200 successful operation < string, object > map
400 Attempting to remove a favorite by id that does not exist No Content
403 Attempting to remove a favorite for a user other than the authenticated user No Content
Produces
  • application/json

Metrics

Retrieves a List of Metrics for the Given Report Suite

Returns a list of metrics for the given report suite

GET /metrics
Description

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.

Parameters
Type Name Description Schema Default
Query expansion
optional		 Add extra metadata to items (comma-delimited list) < enum (tags, approved, favorite, usageSummary, attributes) > array(multi)
Query locale
optional		 Locale that system named metrics should be returned in string "en_US"
Query rsid
required		 ID of desired report suite ie. sistr2 string
Query segmentable
optional		 Filter the metrics by if they are valid in a segment. boolean "false"
Responses
HTTP Code Description Schema
200 successful operation AnalyticsMetric
400 Invalid JSON input No Content
403 Insufficient access to perform operation No Content
500 Unexpected internal server error No Content
Produces
  • application/json

Returns a metric for the given report suite

GET /metrics/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews string
Query expansion
optional		 Add extra metadata to items (comma-delimited list) < enum (tags, approved, favorite, usageSummary, attributes) > array(multi)
Query includeHidden
optional		 Whether to include variables that are hidden in the UI or that the user doesn't have permission to. boolean "false"
Query locale
optional		 Locale that system named metrics should be returned in string "en_US"
Query rsid
required		 ID of desired report suite ie. sistr2 string
Responses
HTTP Code Description Schema
200 successful operation AnalyticsMetric
400 Invalid JSON input No Content
403 Insufficient access to perform operation No Content
500 Unexpected internal server error No Content
Produces
  • application/json

Reports

Ranked reports service

Runs a report for the request in the post body

POST /reports
Description

See the Reporting Interface wiki page for details.

Parameters
Type Name Description Schema Default
Query allowRemoteLoad
optional		 Controls if Oberon should remote load data. Default behavior is true with fallback to false if remote data does not exist enum (true, false, default) "default"
Query includeOberonXml
optional		 Controls if Oberon XML should be returned in the response - DEBUG ONLY enum (true, false) "false"
Query includePlatformPredictiveObjects
optional		 Controls if platform Predictive Objects should be returned in the response. Only available when using Anomaly Detection or Forecasting- DEBUG ONLY enum (true, false) "false"
Query useCache
optional		 Use caching for faster requests (Use cached dimensions to speed up permission checks - This does not do any report caching) boolean "true"
Query usesCatalogIdentities
optional		 Whether this ranked request uses Catalog identities (true) or usual Analytics identities (false). Uses server default (host specific) when not passed. boolean
Body parameter

Name : body
Flags : optional
Type : RankedRequest

Responses
HTTP Code Description Schema
200 successful operation RankedReportData
400 Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object. ReportErrorStatus
Consumes
  • application/json
Produces
  • application/json

Runs a ranked report for the report in the post body

POST /reports/ranked
Description

See the Reporting Interface wiki page for details.

Parameters
Type Name Description Schema Default
Query allowRemoteLoad
optional		 Controls if Oberon should remote load data. Default behavior is true with fallback to false if remote data does not exist enum (true, false, default) "default"
Query includeOberonXml
optional		 Controls if Oberon XML should be returned in the response - DEBUG ONLY enum (true, false) "false"
Query includePlatformPredictiveObjects
optional		 Controls if platform Predictive Objects should be returned in the response. Only available when using Anomaly Detection or Forecasting- DEBUG ONLY enum (true, false) "false"
Query useCache
optional		 Use caching for faster requests (Use cached dimensions to speed up permission checks - This does not do any report caching) boolean "true"
Query usesCatalogIdentities
optional		 Whether this ranked request uses Catalog identities (true) or usual Analytics identities (false). Uses server default (host specific) when not passed. boolean
Body parameter

Name : body
Flags : optional
Type : RankedRequest

Responses
HTTP Code Description Schema
200 successful operation RankedReportData
400 Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object. ReportErrorStatus
Consumes
  • application/json
Produces
  • application/json

Returns a segment summary report for the segment definition in the post body

POST /reports/segmentSummary
Description

Requires rsid and definition. Used to validate a segment definition and return basic reporting metrics for that definition.

The response contains products that the definition is compatible with, as well as a series of totals that represent how many Page Views, Visits, and Visitors the segment includes.

Format for the order of Totals in response:

  1. Number of Page Views that the segment includes for the given time period

  2. Number of Visits that the segment includes for the given time period

  3. Number of Unique Visitors that the segment includes for the given time period

  4. Total number of Page Views for the time period (non-segmented)

  5. Total number of Visits for the time period (non-segmented)

  6. Total number of Unique Visitors for the time period (non-segmented)

The overall totals (3-6) can be used with the segment totals (1-3) to determine the percentage of the segment's audience for each metric.

Example definition for use in testing API below ("Page exists"):


{
	"func": "segment",
	"container": {
		"func": "container",
		"context": "hits",
		"pred": {
			"func": "exists",
			"description": "Page",
			"val": {
				"func": "attr",
				"name": "variables/page"
			}
		}
	},
	"version": [1, 0, 0]
}
Parameters
Type Name Description Schema Default
Query allowRemoteLoad
optional		 Controls if Oberon should remote load data. Default behavior is true with fallback to false if remote data does not exist enum (true, false, default) "default"
Query dateRange
optional		 Format: YYYY-MM-DD/YYYY-MM-DD string
Query endDate
optional		 Format: YYYY-MM-DD string
Query includeOberonXml
optional		 Controls if Oberon XML should be returned in the response - DEBUG ONLY enum (true, false) "false"
Query includeVisitorsMcvisid
optional		 Controls if Visitors with Experience Cloud ID should be returned in the response enum (true, false) "false"
Query locale
optional		 Locale string "en_US"
Query rsid
required		 RSID to run the report against string
Query startDate
optional		 Format: YYYY-MM-DD string
Body parameter

Segment definition

Name : body
Flags : required
Type : string

Responses
HTTP Code Description Schema
200 successful operation SegmentSummaryResponse
400 Bad JSON input; request not formatted correctly No Content
403 User does not have access to run this report No Content
500 Unexpected error; failed to run report No Content
Consumes
  • application/json
Produces
  • application/json

Returns a top items report for the given dimension

GET /reports/topItems
Description

Get the top X items (based on paging restriction) for the specified dimension and rsid. Defaults to last 90 days.

Search Clause examples: contains test: 'test'

contains test or test1: 'test' OR 'test1'

contains test and test1: 'test' AND 'test1'

contains test and not (test1 or test2): 'test' AND NOT ('test1' OR 'test2')

does not contain test: NOT 'test'

Parameters
Type Name Description Schema Default
Query allowRemoteLoad
optional		 Controls if Oberon should remote load data. Default behavior is true with fallback to false if remote data does not exist enum (true, false, default) "default"
Query dateRange
optional		 Format: YYYY-MM-DD/YYYY-MM-DD string
Query dimension
required		 Dimension to run the report against. Example: "variables/page" string
Query endDate
optional		 Format: YYYY-MM-DD string
Query includeOberonXml
optional		 Controls if Oberon XML should be returned in the response - DEBUG ONLY enum (true, false) "false"
Query limit
optional		 Number of results per page integer 10
Query locale
optional		 Locale string "en_US"
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query rsid
required		 RSID to run the report against string
Query search-clause
optional		 General search string; wrap with single quotes. Example: 'PageABC' string
Query searchAnd
optional		 Search terms that will be AND-ed together. Space delimited. string
Query searchNot
optional		 Search terms that will be treated as NOT including. Space delimited. string
Query searchOr
optional		 Search terms that will be OR-ed together. Space delimited. string
Query searchPhrase
optional		 A full search phrase that will be searched for. string
Query startDate
optional		 Format: YYYY-MM-DD string
Responses
HTTP Code Description Schema
200 successful operation UnhashReportData
403 User does not have access to run this report No Content
500 Unexpected error; failed to run report No Content
Produces
  • application/json

Reportsuites

Analytics Report Suite Service

Retrieves report suites that match the given filters.

GET /reportsuites
Parameters
Type Name Description Schema Default
Query expansion
optional		 Comma-delimited list of additional report suite metadata fields to include on response. < enum (calendarType, reportSuiteName, baseUrl, defaultPage, currency, calendarAnchorDate, timezone, timezoneZoneinfo) > array(multi)
Query limit
optional		 Number of results per page integer 10
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query rsidContains
optional		 Filter list to only include suites whose rsid contains rsidContains. string
Query rsidOrNameContains
optional		 Filter list to only include suites whose rsid or report suite name contains rsidOrNameContains. string
Query rsids
optional		 Filter list to only include suites in this RSID list (comma-delimited) string
Responses
HTTP Code Description Schema
200 successful operation AnalyticsReportSuite
500 Unexpected error; report suite retrieval failed No Content
Produces
  • application/json

Retrieves calendar type for a single report suite.

GET /reportsuites/{rsid}/calendartype
Parameters
Type Name Description Schema
Path rsid
required		 rsid string
Responses
HTTP Code Description Schema
200 successful operation CalendarType
500 Unexpected error; retrieval of report suite calendar type failed due to an internal error No Content
Produces
  • application/json

Segments

These operations manage Adobe Analytics Segments. Segments are used to isolate interesting groups of visitors, visits, or hits.

Creates Segment

POST /segments
Parameters
Type Name Description Schema Default
Query expansion
optional		 Comma-delimited list of additional segment metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, approved, favorite, shares, tags, sharesFullName, usageSummary, compatibility, definition) > array(multi)
Query locale
optional		 Locale string "en_US"
Query version
optional		 Decides the version of segment service enum (old, new) "old"
Body parameter

JSON-formatted Object containing key/value pairs for segment creation.

Name : body
Flags : optional
Type : < string, object > map

Responses
HTTP Code Description Schema
200 successful operation AnalyticsSegmentResponseItem
400 Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object. No Content
500 External API error; Segment create or retrieval failed No Content
Consumes
  • application/json
Produces
  • application/json

Retrieve All Segments

GET /segments
Parameters
Type Name Description Schema Default
Query curatedRsid
optional		 Include the curatedItem status for given report suite ID string
Query dataGroup
optional		 Filter list to only include segments with the given data group string
Query dataType
optional		 Filter list to only include segments compatible with the specified product enum (dw, oberon)
Query expansion
optional		 Comma-delimited list of additional segment metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, approved, favorite, shares, tags, sharesFullName, usageSummary, compatibility, definition) > array(multi)
Query filterByIds
optional		 Filter list to only include segments in the specified list (comma-delimited list of IDs) (this is the same as segmentFilter, and is overwritten by segmentFilter string
Query filterByModifiedAfter
optional		 Filter list to only include segments modified since this date (ISO8601 format) string
Query includeType
optional		 Include additional segments not owned by user. The "all" option takes precedence over "shared" < enum (shared, all, templates, deleted, internal, curatedItem) > array(multi)
Query limit
optional		 Number of results per page integer 10
Query locale
optional		 Locale string "en_US"
Query name
optional		 Filter list to only include segments that contains the Name string
Query ownerId
optional		 Filter list to only include segments owned by the specified loginId integer (int32)
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query pagination
optional		 Return paginated results enum (true, false) "false"
Query reportTimeAttribution
optional		 Filter list to only include segments by reportTimeAttribution boolean
Query rsids
optional		 Filter list to only include segments tied to specified RSID list (comma-delimited) string
Query segmentFilter
optional		 Filter list to only include segments in the specified list (comma-delimited list of IDs) string
Query tagNames
optional		 Filter list to only include segments that contains one of the tags string
Query toBeUsedInRsid
optional		 Required when reportTimeAttribution != null or expansion=reportTimeAttribution string
Query version
optional		 Decides the version of segment service enum (old, new) "old"
Responses
HTTP Code Description Schema
200 successful operation AnalyticsSegmentResponseItem
400 Unable to retrieve list of segments shared with user No Content
401 Owner filter error; user specified is not in the same company as the requesting user No Content
403 Requesting non-shared segments for other users is restricted to admin users No Content
500 External API error; Segment retrieval failed No Content
Produces
  • application/json

AAM Status

GET /segments/aamstatus
Description

Checks the provided report suite to see if it is configured to allow segment sharing with Adobe Audience Manager.

Parameters
Type Name Description Schema Default
Query rsid
required		 Report suite ID to check status for string
Query version
optional		 Decides the version of segment service enum (old, new) "old"
Responses
HTTP Code Description Schema
200 successful operation object
500 External API error; failed to check status for given RSID No Content
Produces
  • application/json

Get a Single Segment

GET /segments/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The segment ID to retrieve string
Query expansion
optional		 Comma-delimited list of additional segment metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, approved, favorite, shares, tags, sharesFullName, usageSummary, compatibility, definition) > array(multi)
Query locale
optional		 Locale string "en_US"
Query toBeUsedInRsid
optional		 Evaluate the reportTimeAttribution/customerJourney compatibility for the provided report suite ID string
Query version
optional		 Decides the version of segment service enum (old, new) "old"
Responses
HTTP Code Description Schema
200 successful operation AnalyticsSegmentResponseItem
403 Requesting non-shared segments for other users is restricted to admin users No Content
500 External API error; segment retrieval failed No Content
Produces
  • application/json

Update a Segment

PUT /segments/{id}
Parameters
Type Name Description Schema Default
Path id
required		 Segment ID to be updated string
Query expansion
optional		 Comma-delimited list of additional segment metadata fields to include on response. < enum (reportSuiteName, siteTitle, ownerFullName, modified, approved, favorite, shares, tags, sharesFullName, usageSummary, compatibility, definition) > array(multi)
Query locale
optional		 Locale string "en_US"
Query version
optional		 Decides the version of segment service enum (old, new) "old"
Body parameter

JSON-formatted Object containing key/value pairs to be updated.

Name : body
Flags : optional
Type : < string, object > map

Responses
HTTP Code Description Schema
200 successful operation AnalyticsSegmentResponseItem
400 Definition must be formatted as a JSON Object No Content
401 Company mismatch; segment ownership can only be transferred within the same organization No Content
403 User does not have permission to update this segment No Content
500 External API error; Segment update or retrieval failed No Content
Consumes
  • application/json
Produces
  • application/json

Delete Segment

DELETE /segments/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The segment ID to be deleted string
Query locale
optional		 Locale string "en_US"
Query version
optional		 Decides the version of segment service enum (old, new) "old"
Responses
HTTP Code Description Schema
200 successful operation string
500 External API error; Segment delete failed No Content
Produces
  • application/json

Tags

Operations on tags

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

POST /tags
Description

Allows creation of a new tag and applies that new tag to the passed component

Body parameter

JSON-formatted array of Tag objects containing key-value pairs

Name : body
Flags : optional
Type : < Tag > array

Responses
HTTP Code Description Schema
200 successful operation < Tag > array
500 Unable to save list of tags. No Content
Consumes
  • application/json
Produces
  • application/json

Returns a list of tags for the current user's company

GET /tags
Parameters
Type Name Description Schema Default
Query limit
optional		 Number of results per page integer 10
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Responses
HTTP Code Description Schema
200 successful operation < Tag > array
500 Unable to retrieve list of tags for user. No Content
Produces
  • application/json

Disassociates all tags from the given components

DELETE /tags
Description

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.

Parameters
Type Name Description Schema
Query componentIds
required		 Comma-separated list of componentIds to operate on. string
Query componentType
required		 The component type to operate on. enum (segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classificationSet)
Responses
HTTP Code Description Schema
200 successful operation < string, object > map
400 Invalid component type. No Content
500 Unable to remove tags for given components. No Content
Produces
  • application/json

Retrieves a tags for a given component by componentId and componentType

GET /tags/search
Description

Given a componentId, return all tags associated with that component

Parameters
Type Name Description Schema
Query componentId
required		 The componentId to operate on. Currently this is just the segmentId. string
Query componentType
required		 The component type to operate on. enum (segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classificationSet)
Responses
HTTP Code Description Schema
200 successful operation < Tag > array
400 Invalid component type. No Content
500 Unable to retrieve tags for given component. No Content
Produces
  • application/json

Tag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations

PUT /tags/tagitems
Description

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

Body parameter

JSON-formatted object containing key-value pairs that conform to the schema

Name : body
Flags : optional
Type : < TaggedComponent > array

Responses
HTTP Code Description Schema
200 successful operation < TaggedComponent > array
500 Unable to save tag list. No Content
Consumes
  • application/json
Produces
  • application/json

Retrieves an tag by its id

GET /tags/{id}
Parameters
Type Name Description Schema
Path id
required		 Tag ID to be retrieved integer (int32)
Responses
HTTP Code Description Schema
200 successful operation Tag
404 Unable to find a tag with the given ID No Content
500 Unexpected server error while trying to retrieve tag No Content
Produces
  • application/json

Removes the tagId and all associations from that tag to any components

DELETE /tags/{id}
Description

Delete by tagId. Will un-tag any/all components that were associated with the passed tagId.

Parameters
Type Name Description Schema
Path id
required		 The tagId to be deleted integer (int32)
Responses
HTTP Code Description Schema
200 successful operation < string, object > map
404 The given tagId does not exist No Content
500 Unable to delete the given tagId. No Content
Produces
  • application/json

Timezones

Timezone Operations

Retrieves timezones available to be used in Adobe Analytics.

GET /timezones
Parameters
Type Name Description Schema Default
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation < Timezone > array
500 Unexpected error; timezone retrieval failed No Content
Produces
  • application/json

Virtualreportsuites

Operations on virtual report suites

Creates a new virtual report suite

POST /virtualreportsuites
Description

Creates a virtual report suite. The following attributes are available when creating a virtual report suite: Required: name, parentRsid

Parameters
Type Name Description Schema Default
Query expansion
optional		 Comma-delimited list of additional virtual report suite metadata fields to include on response. < enum (globalCompanyKey, parentRsid, parentRsidName, timezone, timezoneZoneinfo, currentTimezoneOffset, segmentList, description, modified, isDeleted, approved, favorite, tags, ownerFullName, compatibility) > array(multi)
Query locale
optional		 Locale string "en_US"
Body parameter

JSON-formatted Object containing key/value pairs for virtual report suite creation.

Name : body
Flags : optional
Type : AnalyticsVirtualReportSuite

Responses
HTTP Code Description Schema
200 successful operation AnalyticsVirtualReportSuite
400 Invalid input; name and parentRsid are required. No Content
500 External API error; Virtual report suite create or retrieval failed No Content
Consumes
  • application/json
Produces
  • application/json

Retrieves virtual report suites accessible to the current user.

GET /virtualreportsuites
Parameters
Type Name Description Schema Default
Query expansion
optional		 Comma-delimited list of additional virtual report suite metadata fields to include on response. < enum (globalCompanyKey, parentRsid, parentRsidName, timezone, timezoneZoneinfo, currentTimezoneOffset, segmentList, description, modified, isDeleted, approved, favorite, tags, ownerFullName, compatibility) > array(multi)
Query filterByModifiedAfter
optional		 Filter list to only include virtual report suites modified since this date (ISO8601 format) string
Query idContains
optional		 Filter list to only include suites whose id contains idContains. string
Query limit
optional		 Number of results per page integer 10
Query locale
optional		 Locale string "en_US"
Query page
optional		 Page number (base 0 - first page is "0") integer 0
Query rsids
optional		 Filter list to only include suites in this RSID list (comma-delimited) string
Responses
HTTP Code Description Schema
200 successful operation AnalyticsVirtualReportSuite
500 Unexpected error; virtual report suite retrieval failed No Content
Produces
  • application/json

Retrieves a single virtual report suite by ID.

GET /virtualreportsuites/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The vrsid to retrieve string
Query expansion
optional		 Comma-delimited list of additional virtual report suite metadata fields to include on response. < enum (globalCompanyKey, parentRsid, parentRsidName, timezone, timezoneZoneinfo, currentTimezoneOffset, segmentList, description, modified, isDeleted, approved, favorite, tags, ownerFullName, compatibility) > array(multi)
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation AnalyticsVirtualReportSuite
500 Unexpected error; virtual report suite retrieval failed No Content
Produces
  • application/json

Updates configuration for a virtual report suite.

PUT /virtualreportsuites/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The vrsid to update string
Query expansion
optional		 Comma-delimited list of additional virtual report suite metadata fields to include on response. < enum (globalCompanyKey, parentRsid, parentRsidName, timezone, timezoneZoneinfo, currentTimezoneOffset, segmentList, description, modified, isDeleted, approved, favorite, tags, ownerFullName, compatibility) > array(multi)
Query locale
optional		 Locale string "en_US"
Body parameter

JSON-formatted Object containing virtual report suite keys/value pairs to be updated.

Name : body
Flags : optional
Type : AnalyticsVirtualReportSuite

Responses
HTTP Code Description Schema
200 successful operation AnalyticsVirtualReportSuite
Produces
  • application/json

Delete a virtual report suite by ID

DELETE /virtualreportsuites/{id}
Parameters
Type Name Description Schema Default
Path id
required		 The virtual report suite ID to be deleted string
Query locale
optional		 Locale string "en_US"
Responses
HTTP Code Description Schema
200 successful operation DeleteResponse
500 External API error; Virtual report suite delete failed No Content
Produces
  • application/json