Saltar a la navegación

Campagnegeschiedenis opvragen

Geeft de gebeurtenissen van een campagne terug: wat er verstuurd, geopend en aangeklikt is. Een campagne levert al snel veel gebeurtenissen op, dus haal de volgende pagina op met cursor uit pagination. The full event history of a campaign. A campaign can contain many events; use pagination to retrieve additional pages. Gibt die Ereignisse einer Kampagne zurück: was versendet, geöffnet und angeklickt wurde. Eine Kampagne liefert schnell viele Ereignisse, hole die nächste Seite deshalb mit cursor aus pagination ab. Devuelve los eventos de una campaña: qué se ha enviado, abierto y clicado. Una campaña genera enseguida muchos eventos, así que consulta la página siguiente con cursor de pagination.

Autenticación

AuthorizationBasic
Vul je API-sleutel in bij api_key en laat leave_empty leeg. De API gebruikt basic auth, waarbij je sleutel de plaats van de gebruikersnaam inneemt. In curl schrijf je dat als -u JOUW_SLEUTEL:, met een dubbele punt en niets erachter. Enter your API key at api_key and leave leave_empty empty. The API uses basic auth, with your key in place of the username. In curl that reads -u YOUR_KEY:, with a colon and nothing after it. Trage deinen API-Schlüssel bei api_key ein und lass leave_empty leer. Die API nutzt Basic Auth, wobei dein Schlüssel an die Stelle des Benutzernamens tritt. In curl schreibst du das als -u DEIN_SCHLUESSEL:, mit einem Doppelpunkt und nichts dahinter. Introduce tu clave API en api_key y deja leave_empty vacío. La API usa basic auth, con tu clave en lugar del nombre de usuario. En curl se escribe como -u TU_CLAVE:, con dos puntos y nada después.

Parámetros de ruta

campaign_idstringRequerido
Het id van de campagne. Dat vind je in het antwoord van Alle campagnes opvragen. The id of the campaign. You find it in the response of Get all campaigns. Die ID der Kampagne. Du findest sie in der Antwort von Alle Kampagnen abrufen. El id de la campaña. Lo encuentras en la respuesta de Obtener todas las campañas.

Parámetros de consulta

event_date_fromstringOpcional
Geef alleen events vanaf dit moment terug, inclusief. Gebruik het gewone formaat of ISO-formaat zoals hierboven beschreven. Only return events from this date and time, inclusive. Use the regular format or ISO format described above. Gib nur Events ab diesem Zeitpunkt zurück, inklusive. Verwende das normale Format oder das ISO-Format wie oben beschrieben. Devuelve solo los eventos a partir de este momento, incluido. Usa el formato normal o el formato ISO descrito arriba.
event_date_tostringOpcional
Geef alleen events voor dit moment terug, exclusief. Gebruik het gewone formaat of ISO-formaat zoals hierboven beschreven. Only return events before this date and time, exclusive. Use the regular format or ISO format described above. Gib nur Events vor diesem Zeitpunkt zurück, exklusive. Verwende das normale Format oder das ISO-Format wie oben beschrieben. Devuelve solo los eventos anteriores a este momento, excluido. Usa el formato normal o el formato ISO descrito arriba.
limitintegerOpcional
Maximum aantal history-items dat wordt teruggegeven. Standaard 100, maximaal 1000. Maximum number of history items to return. Default is 100, maximum is 1000 Maximale Anzahl an history-Items, die zurückgegeben werden. Standard 100, maximal 1000. Número máximo de elementos de historial que se devuelven. Por defecto 100, máximo 1000.
cursorstringOpcional
Cursor uit pagination.next_cursor om de volgende pagina op te vragen. Interpreteer deze waarde niet zelf; stuur hem ongewijzigd terug. Cursor from pagination.next_cursor to request the next page. Do not interpret this value yourself; send it back unchanged. Cursor aus pagination.next_cursor, um die nächste Seite abzurufen. Interpretiere diesen Wert nicht selbst; schicke ihn unverändert zurück. Cursor de pagination.next_cursor para consultar la página siguiente. No interpretes tú mismo este valor; devuélvelo sin cambios.
order_bystringOpcional
Veld waarop gesorteerd wordt. Op dit moment wordt alleen event_date ondersteund. Field to order by. Currently only event_date is supported Feld, nach dem sortiert wird. Zurzeit wird nur event_date unterstützt. Campo por el que se ordena. Por ahora solo se admite event_date.
orderenumOpcional
Sorteerrichting: desc of asc. Standaard desc. Sort direction: desc or asc. Default is desc Sortierrichtung: desc oder asc. Standard desc. Dirección de ordenación: desc o asc. Por defecto desc.
Valores permitidos:

Respuesta

De aanvraag is gelukt. The request succeeded. Die Anfrage war erfolgreich. La solicitud se ha realizado correctamente.
paginationobjectOpcional
orderobjectOpcional
filtersobjectOpcional
datalist of objectsOpcional

Errores

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error