---
title: "Get banner delivery probability"
type: reference
method: GET
path: /rest-api/placements/{placementId}/banner-probability.do
tag: "Placements"
---

# Get banner delivery probability

`GET https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/banner-probability.do`

Simulates an ad request to the placement and returns each eligible banner with the probability it is served, as the console's Banners Probability card does. Country, browser, operating system and mobile carrier describe the simulated visitor; a dimension that is not sent is simulated as unknown, which still fails a rule that targets it. List a dimension in ignore to leave its targeting out of the match altogether. A banner that matches the simulated visitor but gets no share of the rotation - zero weight, or House ads priority beside other campaigns - is returned with probability -1. A linked banner that does not match the visitor, is paused, or belongs to a paused or ended campaign is not in the simulation and is not listed; read the placement's banners for those. Group by CAMPAIGN or ADVERTISER to sum the rows. Requires ENABLED level on the BANNERS_PROBABILITY_VISIBILITY permission and VIEW access to the placement's site.

## Path params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `placementId` | integer | yes | `4001` | Placement ID |

## Query params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `browser` | string | no | `CHROME` | Browser of the simulated visitor |
| `countryCode` | string | no | `US` | ISO 3166 country code of the simulated visitor |
| `dir` | string | no | `DESC` | ASC or DESC |
| `group` | string | no | `BANNER` | BANNER, CAMPAIGN or ADVERTISER; the latter two sum the probabilities per campaign or advertiser |
| `ignore` | array<string> | no | `BROWSER,OPERATING_SYSTEM` | Targeting to leave out of the match |
| `limit` | integer | no | `50` | Rows per page, 1 to 1000 |
| `mobileCarrier` | string | no | `Verizon` | Mobile carrier of the simulated visitor |
| `operatingSystem` | string | no | `ANDROID` | Operating system of the simulated visitor |
| `priority` | string | no | `STANDARD_HIGH` | Count only campaigns of this delivery priority; IGNORE counts all |
| `query` | string | no | `summer` | Keep only rows whose banner, campaign or advertiser name contains this text |
| `sort` | string | no | `probability` | bannerName, campaignName, advertiserName or probability |
| `start` | integer | no | `0` | Offset of the first row returned |

## Responses

- `200` — {success, total, data:[{bannerId, bannerName, campaignId, campaignName, advertiserId, advertiserName, probability}]}
- `400` — An invalid enum, group, sort, dir, start or limit; the error names the field and the accepted values
- `401` — Authentication error
- `403` — No BANNERS_PROBABILITY_VISIBILITY permission, or no VIEW access to the site
- `404` — Placement not found or deleted

## Example request

```bash
curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/banner-probability.do?browser=CHROME&countryCode=US&dir=DESC' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Source: https://epom.com/ad-server/docs/api/placements/get-placements-banner-probability