> 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/es/red/api-de-la-red/api-de-limitacion.md).

# API de limitación

{% code overflow="wrap" %}

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

{% endcode %}

### Parámetros comunes

| Consulta   | Tipo   | Descripción             |
| ---------- | ------ | ----------------------- |
| mid        | Entero | ID de cuenta de la red  |
| api-key    | Cadena | Clave API de la red     |
| secret-key | Cadena | Clave secreta de la red |

**Acción**

| Consulta  | Tipo   | Descripción                                           |
| --------- | ------ | ----------------------------------------------------- |
| action    | Cadena | **Valores permitidos:** crear / actualizar / eliminar |
| offer\_id | Entero | Requerido para todas las acciones                     |

###

### Filtro

<table><thead><tr><th>Consulta</th><th width="249">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td>rule_id</td><td>Entero</td><td>ID de la regla de límite</td></tr><tr><td>status</td><td>Cadena</td><td>habilitar/deshabilitar</td></tr><tr><td>limit</td><td>Entero</td><td>Número de reglas de límite por página (máx. 30 reglas)</td></tr><tr><td>page</td><td>Entero</td><td>Número de 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">Descripción</th></tr></thead><tbody><tr><td>offer_id</td><td>Entero</td><td>ID de la oferta</td></tr><tr><td>rule_name</td><td>Cadena</td><td>Nombre de la regla de límite</td></tr><tr><td>rule_type</td><td>Cadena</td><td><ul><li>advertiser_capping</li><li>affiliate_capping</li></ul></td></tr><tr><td>affiliate_id</td><td>Entero</td><td>ID de afiliado si es límite de afiliado</td></tr><tr><td>timezone</td><td>Entero</td><td>Zona horaria del límite</td></tr><tr><td>capping_type</td><td>Cadena</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>Cadena</td><td><ul><li>diario</li><li>semanal</li><li>mensual</li><li>por hora</li></ul></td></tr><tr><td>capping_value</td><td>Entero</td><td>Valor de límite</td></tr><tr><td>overcap_action</td><td>Cadena</td><td><ul><li>detener</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>Cadena</td><td>Evento para el límite de eventos</td></tr><tr><td>affiliate_visibility</td><td>Cadena</td><td><ul><li>mostrar</li><li>ocultar</li></ul></td></tr><tr><td>notification_email</td><td>Cadena</td><td>ID de correo electrónico para la notificación de límite</td></tr><tr><td>notification_earlier_threshold</td><td>Cadena</td><td>ID de correo electrónico para la notificación del umbral de límite</td></tr><tr><td>status</td><td>Cadena</td><td><p>Estado de la regla de límite</p><ul><li>habilitar</li><li>deshabilitar</li></ul></td></tr><tr><td>rule_id</td><td>Entero</td><td>Para actualizar y eliminar la regla de límite</td></tr></tbody></table>

## Ejemplo de solicitud de API <a href="#example-api-request" id="example-api-request"></a>

<figure><img src="https://497363578-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2FukdAzleiUY7pt85SrOML%2Fcappingapi.png?alt=media&amp;token=3bacdd3e-01b7-4ed1-82ae-733324362647" alt=""><figcaption></figcaption></figure>

### Respuesta de la 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>