---
updatedAt: 2025-08-28T17:15:04.000Z
agentTools:
  projectIndex: https://docs.scope3.com/v1.3/llms.txt
---

# Planning

Estimate the emissions for a media plan

## API Status

The Planning API is currently in closed beta. You will need an API key to use it - please contact Scope3 if you would like access!

## Input parameters

The parameter list below represents our recommended set of parameters. Please see API Reference for a full list of supported parameters.

### Row

| Parameter            | Values                                                                                           | Required | Comments                                                                        |
| -------------------- | ------------------------------------------------------------------------------------------------ | -------- | ------------------------------------------------------------------------------- |
| `channel`            | `display-web`, `display-app`, `streaming-video`, `social`                                        | yes      |                                                                                 |
| `country`            | string                                                                                           | yes      | The [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) |
| `weightedSellerList` | See below                                                                                        | no       | Weighted list of sellers that will be on the plan                               |
| `creative`           | creative object                                                                                  | yes      | Must provide at least `format`                                                  |
| `deviceType`         | phone, tablet, pc, tv                                                                            | yes      |                                                                                 |
| `buyingMethod`       | `direct`,  `direct-takeover`, `programmatic-open`, `programmatic-pmp`, `programmatic-guaranteed` | no       | The method used to buy the impressions                                          |
| `impressions`        | integer                                                                                          | yes      |                                                                                 |

### Weighted Seller List

| Parameter | Values | Required | Comments                                                                                                                                                                  |
| :-------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `seller`  | string | yes      | The seller of the impressions. Follows same rules as in the Campaign API - will look up an organization that matches the seller and fall back to a matching domain or app |
| `weight`  | float  | yes      | The weights are divided by the total weight then multiplied by the `impressions`. This provides the flexibility to use percentages or actual impression numbers.          |

Example

```json
"weightedSellerList":[{"seller":"google","weight":95},{"seller":"bing","weight":5}]
```

## Output parameters

| Parameter                                    | Values     | Comments                                                                                                                                        |
| -------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `totalCreativeDistributionEmissions`         | gCO2e      | Creative delivery including data transfer and all vendors involved.                                                                             |
| `totalAdSelectionMediaDistributionEmissions` | gCO2e      | Ad Selection + Media Distribution emissions for the plan                                                                                        |
| `totalEmissions`                             | gCO2e      | Total footprint of the campaign excluding consumer device and excluding compensation (sum of above)                                             |
| `rowsSkipped`                                | int        | Rows that were not processed, usually indicating an unmatched seller                                                                            |
| `rows`                                       | JSON array | Provides the above fields for each seller in the `weightedSellerList` in the same order as they are provided above, as well as an `error` field |

## Examples

See [Google Sheets Integration](https://dash.readme.com/project/scope3/v1.2/docs/google-sheets-integration) for a script to use the Planning API in a Google Sheet.