# Ler os parâmetros de uma URL

> Lê os parâmetros de uma URL (o que vem depois do ?) e devolve cada um com o seu valor.

Endereço: https://docs.nextags.com.br/referencia/ferramentas/ler-os-parametros-de-uma-url/
Tipo: Endpoint

```http
POST https://app.nextagsai.com.br/api/tools/get_url_parameters
X-ACCESS-TOKEN: <sua chave de API>
```

Lê os parâmetros de uma URL (o que vem depois do `?`) e devolve cada um com o seu valor. Use para pegar a origem de quem chegou por um link com UTM, como `utm_source` e `utm_campaign`.

Autenticação: Mande a chave de API da conta no cabeçalho `X-ACCESS-TOKEN` de cada chamada. Veja [Autenticação com a chave de API](https://docs.nextags.com.br/comecar/autenticacao/).

## Corpo da requisição (formulário, application/x-www-form-urlencoded)

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `url` | string | sim | A URL completa, com os parâmetros. |

```json
{
  "url": "https://loja.exemplo.com.br/?utm_source=instagram&utm_campaign=black-friday&ref=ana"
}
```

## Exemplo

```bash
curl -X POST "https://app.nextagsai.com.br/api/tools/get_url_parameters" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  --data-urlencode 'url=https://loja.exemplo.com.br/?utm_source=instagram&utm_campaign=black-friday&ref=ana'
```

Os exemplos em JavaScript, Python e PHP estão na página e no contrato (`x-codeSamples` em https://docs.nextags.com.br/openapi.json).

## Respostas

### 200 Sucesso

Os parâmetros, em `data`: um campo para cada parâmetro da URL, com o nome e o valor.

| Campo | Tipo | Descrição |
|---|---|---|
| `data` | object | Os parâmetros da URL. Cada parâmetro vira um campo deste objeto, com o mesmo nome. |

```json
{
  "data": {
    "utm_source": "instagram",
    "utm_campaign": "black-friday",
    "ref": "ana"
  }
}
```

### 401 Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja [Autenticação](https://docs.nextags.com.br/comecar/autenticacao/).

```json
{
  "error": {
    "code": 401,
    "message": "No valid API key provided."
  }
}
```