Skip to content

Exportar lista de campañas

get

/campaigns/list

Usa este punto de conexión para exportar una lista de campañas, cada una de las cuales incluirá su nombre, el identificador de API de la campaña, si se trata de una campaña de API y las etiquetas asociadas a la campaña.

Las campañas se devuelven en grupos de 100 ordenadas por fecha de creación (de la más antigua a la más reciente, por defecto).

See me in Postman

Requisitos previos

Para usar este punto de conexión, necesitarás una clave de API con el permiso campaigns.list.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto de conexión, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
page Opcional Entero La página de campañas a devolver, predeterminada a 0 (devuelve el primer conjunto de hasta 100).
include_archived Opcional Booleano Incluir o no campañas archivadas, predeterminado a false.
sort_direction Opcional Cadena - Ordenar la hora de creación de más reciente a más antigua: introduce el valor desc.
- Ordenar la hora de creación de más antigua a más reciente: introduce el valor asc.

Si no se incluye sort_direction, el orden predeterminado es de la más antigua a la más reciente.
last_edit.time[gt] Opcional Tiempo Filtra los resultados y solo devuelve las campañas que se hayan editado después del tiempo indicado hasta ahora. El formato es yyyy-MM-DDTHH:mm:ss.

Ejemplo de solicitud

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'

Respuesta

1
2
3
4
5
6
7
8
9
10
11
12
13

{
    "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
        },
        ...
    ]
}
New Stuff!