> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/pt/rede/api-da-rede/api-de-limitacao.md).

# API de limitação

{% code overflow="wrap" %}

```
POST https://api.offer18.com/api/m/offer_capping
```

{% endcode %}

### Parâmetros Comuns

| Consulta   | Tipo    | Descrição             |
| ---------- | ------- | --------------------- |
| mid        | Integer | ID da conta da rede   |
| api-key    | String  | Chave de API da rede  |
| secret-key | String  | Chave secreta da rede |

**Ação**

| Consulta  | Tipo    | Descrição                                        |
| --------- | ------- | ------------------------------------------------ |
| action    | String  | **Valores permitidos:** create / update / delete |
| offer\_id | Integer | Obrigatório para todas as ações                  |

###

### Filtro

<table><thead><tr><th>Consulta</th><th width="249">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>rule_id</td><td>Integer</td><td>ID da regra de limitação</td></tr><tr><td>status</td><td>String</td><td>ativar/desativar</td></tr><tr><td>limit</td><td>Integer</td><td>Número de regras de limitação por página (máx. 30 regras)</td></tr><tr><td>page</td><td>Integer</td><td>Número da página</td></tr></tbody></table>

####

{% code overflow="wrap" %}

```
https://api.offer18.com/api/m/offer_capping?mid=000&api-key=000000&secret-key=000000000&action=create
```

{% endcode %}

###

### Campos

<table><thead><tr><th>Consulta</th><th>Tipo</th><th width="263">Descrição</th></tr></thead><tbody><tr><td>offer_id</td><td>Integer</td><td>ID da oferta</td></tr><tr><td>rule_name</td><td>String</td><td>Nome da regra de limitação</td></tr><tr><td>rule_type</td><td>String</td><td><ul><li>advertiser_capping</li><li>affiliate_capping</li></ul></td></tr><tr><td>affiliate_id</td><td>Integer</td><td>ID do afiliado se for limitação de afiliado</td></tr><tr><td>timezone</td><td>Integer</td><td>Fuso horário da limitação</td></tr><tr><td>capping_type</td><td>String</td><td><ul><li>gross_conversions</li><li>approved_conversions</li><li>gross_revenue</li><li>approved_revenue</li><li>gross_payout</li><li>approved_payout</li><li>gross_clicks</li><li>approved_clicks</li></ul></td></tr><tr><td>capping_period</td><td>String</td><td><ul><li>daily</li><li>weekly</li><li>monthly</li><li>hourly</li></ul></td></tr><tr><td>capping_value</td><td>Integer</td><td>Valor da limitação</td></tr><tr><td>overcap_action</td><td>String</td><td><ul><li>stop</li><li>fallback</li><li>fallback_conversion_accept</li><li>conversion_accept</li><li>conversion_reject</li><li>conversion_pending</li></ul></td></tr><tr><td>event</td><td>String</td><td>Evento para limitação por evento</td></tr><tr><td>affiliate_visibility</td><td>String</td><td><ul><li>show</li><li>hide</li></ul></td></tr><tr><td>notification_email</td><td>String</td><td>ID de e-mail para notificação de limitação</td></tr><tr><td>notification_earlier_threshold</td><td>String</td><td>ID de e-mail para notificação do limite de limitação</td></tr><tr><td>status</td><td>String</td><td><p>Status da regra de limitação</p><ul><li>enable</li><li>disable</li></ul></td></tr><tr><td>rule_id</td><td>Integer</td><td>Para atualizar e excluir a regra de limitação</td></tr></tbody></table>

## Exemplo de requisição da API <a href="#example-api-request" id="example-api-request"></a>

<figure><img src="/files/e71e401781bfd49c8d7f40ad82cda81d21e55b24" alt=""><figcaption></figcaption></figure>

### Resposta da API <a href="#api-response" id="api-response"></a>

{% code overflow="wrap" %}

```javascript
{
    "status": 200,
    "response": "capping_rule_created_successfully",
    "data": {
        "rule_id": 70xxx1
    }
}
```

{% endcode %}

<br>