Skip to content

Exportar lista de campanhas

get

/campaigns/list

Use esse ponto de extremidade para exportar uma lista de campanhas, cada uma das quais incluirá seu nome, o identificador da API da campanha, se é uma campanha da API e as tags associadas à campanha.

As campanhas são retornadas em grupos de 100, classificadas por hora de criação (da mais antiga para a mais recente, por padrão).

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão campaigns.list.

Limite de taxa

Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.

Parâmetros de solicitação

Exemplo de solicitação

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/campaigns/list?page=0&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "campaigns" : [
        {
            "id" : (string) the Campaign API identifier,
            "last_edited": (ISO 8601 string) the last edited time for the message
            "name" : (string) the campaign name,
            "is_api_campaign" : (boolean) whether the campaign is an API campaign,
            "tags" : (array) the tag names associated with the campaign formatted as strings
        },
        ...
    ]
}
QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!