Skip to content

Commit

Permalink
Update breakdowns.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johnwight authored Sep 4, 2024
1 parent 28b37a6 commit 09b6597
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions src/pages/guides/endpoints/reports/breakdowns.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,22 @@ descriptions: Use multiple dimensions in the same Reporting API call.

# Breakdown dimensions

Breakdowns in the reporting API are useful when you want to see the cross-product of values from two different dimensions. When requesting a breakdown report, use the `metricsFilters` and `dimension` parameters to request the additional dimension.

The following example requests a breakdown report containing a list of the top five "Internal Search Terms" used by visitors who saw campaign 10. Within the `metricsFilters` parameter, the type is set to `breakdown` (line 21), and `evar1` is the marketing campaign (line 22). Within the `dimensions` parameter, `evar2` is the "Internal Search Terms" (line 27).

<InlineAlert variant="info" slots="text" />

Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

<InlineAlert variant="info" slots="text" />
Breakdowns in the reporting API are useful when you want to see the cross-product of values from two different dimensions. When requesting a breakdown report, use the `metricsFilters` and `dimension` parameters to request the additional dimension.

The following example requests a breakdown report containing a list of the top five "Internal Search Terms" used by visitors who saw campaign 10. Within the `metricsFilters` parameter, the type is set to `breakdown` (line 21), and `evar1` is the marketing campaign (line 22). Within the `dimensions` parameter, `evar2` is the "Internal Search Terms" (line 27).

If the text value of item is already known, it can be passed inside the `metricFilter` object as `itemValue` field (Make sure to pass the exact text value). For example, instead of passing the item id `"itemId":"743855946"` of the item "Campaign 10", we can pass the text value of the item like this `"itemValue" : "10"` Passing an item value instead of item id will result in slightly slower performance, but it will be useful in preventing multiple reporting calls to retrieve item ids.

<CodeBlock slots="heading, code" repeat="2" languages="JSON,JSON"/>

#### Request body
## Example breakdown

This section shows an example request and response of a dimension breakdown.

### Example request

```json
{
Expand Down Expand Up @@ -57,7 +58,11 @@ If the text value of item is already known, it can be passed inside the `metricF
}
```

#### Response
<InlineAlert variant="info" slots="text" />

You can also specify the text value for items instead of item IDs. If you already know the text value for the item, you can specify it with the `itemValue` parameter within the `metricFilter` object. For example, if the item is "Campaign 10", you can specify `"itemValue" : "10"` instead of `"itemId":"743855946"`, as shown above. Use only the text value when specifying the `itemValue`. Passing an item value instead of item ID results in slightly slower performance, but it is useful in preventing multiple reporting calls to retrieve item IDs.

#### Example Response

```json
{
Expand Down

0 comments on commit 09b6597

Please sign in to comment.