Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Observability Insights API (1.0.0)

Download OpenAPI specification:Download

Use the Observability Insights API to programmatically retrieve and monitor metric data for various Adobe Experience Platform features.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Metrics

Observability metrics are parameters used to gain statistical insights into actions being performed in Adobe Experience Platform. These insights include counts of available Platform resources and statistics on data ingestion.

Retrieve metrics data (V1)Deprecated

NOTE: This method is now deprecated. For the latest functionality, please the POST method for this endpoint instead.

The first version of the API allows you to retrieve metric data by supplying applicable metrics in the request path as query parameters.

Request
query Parameters
metric
required
Array of strings [ 1 .. 6 ] items unique

Metrics you wish the API to return insights from. Refer to the documentation for a list of accepted metrics.

id
string

ID associated with the resourceType in the metric.

dateRange
string

A Date Range in ISO 8601 format. Defaults to 30 days if not present for time-series metrics. Defaults to the last day if not present for single-stat metrics.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

A successful response returns information on the metrics specified in the request path.

400

Something was wrong with the request. Typically this means an invalid metric was provided.

get/metrics
Response samples
[
  • {
    }
]

Retrieve metrics data (V2)

This endpoint retrieves metric data based on the properties provided in the request payload.

NOTE: The Observability Insights API currently does not support pagination and returns all matching results in a single response body. To limit response sizes, choose a higher-level granularity value or limit the date range indicated by start and end. > >For more information on using this operation, see the metrics endpoint guide on Experience League.

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

x-sandbox-id
required
string

The id of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Request Body schema: */*
optional
start
string

An ISO 8601 timestamp that represents the start of the date range to return metrics from.

end
string

An ISO 8601 timestamp that represents the end of the date range to return metrics from.

granularity
string

The time interval that the returned metric data is divided by. For example, a value of DAY returns metrics for each day between the start and end date, whereas a value of MONTH would group metric results by month instead.

Array of objects (metricObject)

A list of metrics to query for.

Responses
200

A successful response returns information on the metrics specified in the request payload.

post/metrics
Response samples
application/json
{
  • "metricResponses": [
    ]
}