Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagebash
curl --location 'https://accenture.evolux.cx/api/v1/reports/campaign/subscribers?timezone=America%2FSao_Paulo&start=2024-09-05T00%3A00%3A00.000Z&end=2024-09-06T02%3A59%3A59.999Z&timezone=%3DAmerica%2FSao_Paulo&conversation_field_key=perfil&conversation_field_value=Pessoa%20Jur%C3%ADdica' \
--header 'Authorization: Bearer ********-****-****-****-************'

...

Code Block
languagepy
import requests

# URL base
url = "https://seuservidor.evolux.cx/api/v1/reports/campaign/subscribers"

# Parâmetros da requisição
params = {
    'start': '2024-09-05T00:00:00.000Z',
    'end': '2024-09-06T23:59:59.999Z',
    'timezone': 'America/Sao_Paulo',
    'conversation_field_key': 'perfil',
    'conversation_field_value': 'Pessoa Jurídica'
}

# Cabeçalhos da requisição
headers = {
    'Authorization': 'Bearer ********-****-****-****-************'
}

# Realizando a requisição GET com os parâmetros e cabeçalhos
response = requests.get(url, headers=headers, params=params)

# Imprimindo a resposta
print(response.text)

...

Info

Para especificar uma data, orientamos utilizar a chave “timezone” da sua região (ex: America/Sao_Paulo) e também inserir o horário de início e término de acordo com o seu fuso (ex: em São Paulo, inserir 3 horas para frente)

Info

Caso

2 : Quero obter o resultado de hoje, até o momento, das

sejam obtidos mais retornos do que o especificado no parâmetro “limit” (padrão são 50), a chave “pagination” entrega um valor dentro de “next” que pode ser utilizado como endpoint para a próxima requisição, a fim de obter os resultados da página seguinte.

], "message": "OK", "pagination": { "next": "/api/v1/reports/campaign/subscribers?_limit=50&_offset=50", "total": 6100 }, "status": 200

}

Caso 2 : Quero obter o resultado de hoje, até o momento, das campanhas “Teste - 1" e “Teste - 2”, cujos uuids são respectivamente, f45d98dc-ac5e-48f2-9c01-ebe18f86d28b e e629ed93-0ab7-4319-accb-813330938f84

...

Code Block
languagepy
import requests

url = "https://seuservidor.evolux.cx/api/v1/reports/campaign/subscribers"

params = {
    "campaigns[]": [
        "f45d98dc-ac5e-48f2-9c01-ebe18f86d28b",
        "e629ed93-0ab7-4319-accb-813330938f84"
    ],
    "state": "error",
    'timezone': 'America/Sao_Paulo'
}

headers = {
    'Authorization': 'Bearer ********-****-****-****-************'
}

response = requests.get(url, headers=headers, params=params)

print(response.text)

...

401 - Seu método de autenticação falhou

Code Block
languagejson
{
    "message": "Unauthorized",
    "status": 401
}

...

429 - Você está fazendo requisições mais rapidamente do que o servidor pode suportar

Code Block
languagejson
{
    "message": "Too Many Requests",
    "status": 429
}

...

404 - O endpoint que você está tentando acessar não existe, confira se ele foi escrito corretamente

Code Block
languagejson
{
    "error_message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
    "message": "Not Found",
    "status": 404
}

...

404 - A data de início precisa existir e ser menor do que a de fim

Code Block
languagejson
{
    "error_message": "Start date should not be greater than end date.",
    "key": "start",
    "message": "Not Found",
    "status": 404
}

...

404 - A data de fim não pode ser maior do que a atual (de acordo com o fuso informado)

Code Block
languagejson
{
    "error_message": "End date in future.",
    "key": "end",
    "message": "Not Found",
    "status": 404
}

...