Overzicht van REST API v2 methodes
Account
In de onderstaande tabel vind je een methode om account-informatie op te vragen.
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/identity | Opvragen van account informatie |
GET | api.copernica.com/v2/consumption | Opvragen van account verbruik |
Databases & Collecties
Je kunt je databases en collecties bekijken en onderhouden met API calls. In de onderstaande tabel vind je alle calls gerelateerd aan databases, collecties en hun eigenschappen.
Databases
Collecties
Selecties & Miniselecties
Selecties vallen onder de database, terwijl miniselecties onder een collectie vallen. Je kunt de methodes gerelateerd aan specifieke (mini)selecties hieronder vinden.
Selecties
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2/database/$id/views | Aanmaken van een selectie |
POST | api.copernica.com/v2/view/$id/copy | Kopiëren van een selectie |
GET | api.copernica.com/v2/view/$id | Opvragen van selectie informatie |
PUT | api.copernica.com/v2/view/$id | Updaten van selectie informatie |
DELETE | api.copernica.com/v2/view/$id | Verwijderen van een selectie |
GET | api.copernica.com/v2/view/$id/views | Opvragen van alle genestelde selecties |
POST | api.copernica.com/v2/view/$id/views | Aanmaken van een genestelde selectie |
GET | api.copernica.com/v2/view/$id/profileids | Opvragen van alle selectie profiel IDs |
GET | api.copernica.com/v2/view/$id/profiles | Opvragen van alle selectie profielen |
GET | api.copernica.com/v2/view/$id/rules | Opvragen van alle selectie regels |
GET | api.copernica.com/v2/view/$id/rule/$id | Opvragen van een selectie regel |
POST | api.copernica.com/v2/view/$id/rules | Aanmaken van een selectie regel |
PUT | api.copernica.com/v2/view/$id/intentions | Updaten van de intenties van de selectie |
PUT | api.copernica.com/v2/view/$id/rebuild | Opnieuw opbouwen van een selectie |
Miniselecties
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2/collection/$id/miniviews | Aanmaken van een miniselectie |
GET | api.copernica.com/v2/miniview/$id | Opvragen van miniselectie informatie |
PUT | api.copernica.com/v2/miniview/$id | Updaten van miniselectie informatie |
DELETE | api.copernica.com/v2/miniview/$id | Verwijderen van een miniselectie |
GET | api.copernica.com/v2/miniview/$id/subprofileids | Opvragen van alle miniselectie subprofiel IDs |
GET | api.copernica.com/v2/miniview/$id/subprofiles | Opvragen van alle miniselectie subprofielen |
GET | api.copernica.com/v2/miniview/$id/views | Opvragen van selecties voor een miniselectie |
GET | api.copernica.com/v2/miniview/$id/minirules | Opvragen van alle miniselectie miniregels |
GET | api.copernica.com/v2/miniview/$id/minirule/$id | Opvragen van een miniselectie miniregel |
POST | api.copernica.com/v2/miniview/$id/minirules | Aanmaken van een nieuwe miniselectie miniregel |
PUT | api.copernica.com/v2/miniview/$id/intentions | Updaten van de intenties van de miniselectie |
PUT | api.copernica.com/v2/miniview/$id/rebuild | Opnieuw opbouwen van een miniselectie |
Regels & Miniregels
Regels en miniregels bestaan uit een of meerdere condities om selecties en miniselecties aan te maken onder een database of collectie respectievelijk. Je kunt alle API calls gerelateerd aan (mini)regels en de bijhorende condities in de tabel hieronder vinden.
Regels
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2/view/$id/rules | Aanmaken van een regel |
GET | api.copernica.com/v2/rule/$id | Opvragen van regel informatie |
PUT | api.copernica.com/v2/rule/$id | Updaten van regel informatie |
DELETE | api.copernica.com/v2/rule/$id | Verwijderen van een regel |
POST | api.copernica.com/v2/rule/$id/conditions | Aanmaken van een regel conditie |
PUT | api.copernica.com/v2/condition/$type/$id | Updaten van een conditie |
DELETE | api.copernica.com/v2/condition/$type/$id | Verwijderen van een conditie |
Miniregels (voor miniselecties)
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2/miniview/$id/minirules | Aanmaken van een nieuwe miniregel |
GET | api.copernica.com/v2/minirule/$id | Opvragen van miniregel informatie |
PUT | api.copernica.com/v2/minirule/$id | Updaten van miniregel informatie |
DELETE | api.copernica.com/v2/minirule/$id | Verwijderen van een miniregel |
POST | api.copernica.com/v2/minirule/$id/conditions | Aanmaken van een miniregel conditie |
DELETE | api.copernica.com/v2/minicondition/$type/$id | Verwijderen van een miniregel conditie |
Profielen & Subprofielen
Profielen en subprofielen kunnen gebruikt worden om entiteiten in je database op te slaan, zoals je klanten of orders. Je vindt de relevante API calls in de onderstaande tabel.
Profielen
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2///profiles | Aanmaken van een database profiel |
GET | api.copernica.com/v2/profile/$id | Opvragen van profiel informatie |
PUT | api.copernica.com/v2/profile/$id | Updaten van profiel informatie |
DELETE | api.copernica.com/v2/profile/$id | Verwijderen van een profiel |
GET | api.copernica.com/v2/profile/$id/subprofiles/$id | Opvragen van alle subprofielen voor een profiel |
POST | api.copernica.com/v2/profile/$id/subprofiles/$id | Aanmaken van een nieuw subprofiel |
PUT | api.copernica.com/v2/profile/$id/subprofiles/$id | Updaten van een of meerdere subprofielen |
GET | api.copernica.com/v2/profile/$id/fields | Opvragen van alle profiel velden |
PUT | api.copernica.com/v2/profile/$id/fields | Updaten van een of meerdere profiel velden |
GET | api.copernica.com/v2/profile/$id/interests | Opvragen van alle profiel interesses |
POST | api.copernica.com/v2/profile/$id/interests | Aanmaken van profiel interesse(s) |
PUT | api.copernica.com/v2/profile/$id/interests | Updaten van profiel interesse(s) |
GET | api.copernica.com/v2/profile/$id/publisher/emailings | Opvragen van alle Publisher mailings voor een profiel |
GET | api.copernica.com/v2/profile/$id/ms/emailings | Opvragen van alle Marketing Suite mailings voor een profiel |
GET | api.copernica.com/v2/profile/$id/publisher/destinations | Opvragen van alle Publisher destinations voor een profiel |
GET | api.copernica.com/v2/profile/$id/ms/destinations | Opvragen van alle Marketing Suite destinations voor een profiel |
GET | api.copernica.com/v2/profile/$id/files | Oppvragen van alle files voor een profiel |
POST | api.copernica.com/v2/profile/$id/datarequest | Aanmaken van een dataverzoek voor een profiel |
PUT | api.copernica.com/v2/profile/$id/unsubscribe | Uitvoeren van het uitschrijfgedrag van een profiel |
Subprofielen
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2/profile/$id/subprofiles | Aanmaken van een subprofiel |
GET | api.copernica.com/v2/subprofile/$id | Opvragen van subprofiel informatie |
PUT | api.copernica.com/v2/subprofile/$id | Updaten van subprofiel informatie |
DELETE | api.copernica.com/v2/subprofile/$id | Verwijderen van een subprofiel |
GET | api.copernica.com/v2/subprofile/$id/fields | Opvragen van alle subprofiel velden |
PUT | api.copernica.com/v2/subprofile/$id/fields | Updaten van subprofiel velden |
GET | api.copernica.com/v2/subprofile/$id/publisher/emailings | Opvragen van alle Publisher mailings voor een subprofiel |
GET | api.copernica.com/v2/subprofile/$id/ms/emailings | Opvragen van alle Marketing Suite mailings voor een subprofiel |
GET | api.copernica.com/v2/subprofile/$id/publisher/destinations | Opvragen van alle Publisher destinations voor een subprofiel |
GET | api.copernica.com/v2/subprofile/$id/ms/destinations | Opvragen van alle Marketing Suite destinations voor een subprofiel |
POST | api.copernica.com/v2/subprofile/$id/datarequest | Aanmaken van een dataverzoek voor een subprofiel |
PUT | api.copernica.com/v2/subprofile/$id/unsubscribe | Uitvoeren van het uitschrijfgedrag van een subprofiel |
Publisher Mailings
In de onderstaande tabel vind je alle API calls gerelateerd aan Publisher documenten, templates en mailings.
Mailings
Documenten & Templates
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/publisher/documents | Opvragen van alle documenten |
GET | api.copernica.com/v2/publisher/document/$id | Opvragen van document informatie |
DELETE | api.copernica.com/v2/publisher/document/$id | Verwijderen van een document |
GET | api.copernica.com/v2/publisher/document/$id/emailings | Opvragen van mailings voor een document |
GET | api.copernica.com/v2/publisher/document/$id/statistics | Opvragen van statistieken voor een document |
GET | api.copernica.com/v2/publisher/templates | Opvragen van alle templates |
GET | api.copernica.com/v2/publisher/template/$id | Opvragen van template informatie |
DELETE | api.copernica.com/v2/publisher/template/$id | Verwijderen van een template |
GET | api.copernica.com/v2/publisher/template/$id/emailings | Opvragen van mailings voor een template |
GET | api.copernica.com/v2/publisher/template/$id/emailingdocuments | Opvragen van alle documenten voor een template |
Destinations (bestemmingen)
Statistieken
Marketing Suite Mailings
In de onderstaande tabel vind je alle API calls gerelateerd aan Marketing Suite templates en mailings.
Mailings
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/ms/emailings | Opvragen van alle mailings |
GET | api.copernica.com/v2/ms/emailing/$id | Opvragen van een mailing |
POST | api.copernica.com/v2/ms/emailing | Aanmaken van een mailing |
GET | api.copernica.com/v2/ms/destinations | Opvragen van alle destinations over een bepaalde periode |
GET | api.copernica.com/v2/ms/scheduledemailings | Opvragen van alle ingeroosterde mailings |
GET | api.copernica.com/v2/ms/scheduledemailing/$id | Opvragen van een ingeroosterde mailing |
POST | api.copernica.com/v2/ms/scheduledemailing/ | Aanmaken van een ingeroosterde mailing |
GET | api.copernica.com/v2/ms/emailing/$id/destinations | Opvragen van destinations voor een mailing |
GET | api.copernica.com/v2/ms/emailing/$id/statistics | Opvragen van statistieken voor een mailing |
GET | api.copernica.com/v2/ms/emailing/$id/abuses | Opvragen van alle abuses voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/clicks | Opvragen van alle clicks voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/deliveries | Opvragen van alle deliveries voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/errors | Opvragen van alle errors voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/impressions | Opvragen van alle impressions voor een emailing |
PUT | api.copernica.com/v2/ms/emailing/$id/unsubscribe | (Sub)profiel uitschrijven op basis van een mailing |
GET | api.copernica.com/v2/profile/$id/ms/emailings | Opvragen van alle Marketing Suite mailings voor een profiel |
GET | api.copernica.com/v2/subprofile/$id/ms/emailings | Opvragen van alle Marketing Suite mailings voor een subprofiel |
Templates
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/ms/templates | Opvragen van alle templates |
GET | api.copernica.com/v2/ms/template/$id | Opvragen van een template |
DELETE | api.copernica.com/v2/ms/template/$id | Verwijderen van een template |
GET | api.copernica.com/v2/ms/template/$id/statistics | Opvragen van statistieken voor een template |
Destinations (bestemmingen)
Binnen Copernica's Marketing Suite zijn de termen 'destination' (bestemming) en 'message' (bericht) uitwisselbaar. Beide verwijzen naar een specifiek bericht verzonden naar een specifieke bestemming. In onderstaande artikelen kun je in zowel de tekst 'destination' door 'message' vervangen, of andersom. Dit geldt ook voor de voorbeeldcode.
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/ms/destination/$id | Opvragen van een bestemming |
GET | api.copernica.com/v2/ms/emailing/$id/destinations | Opvragen van bestemmingen voor een mailing |
GET | api.copernica.com/v2/ms/destination/$id/body | Opvragen van de message body verzonden naar een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/statistics | Opvragen van statistieken voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/abuses | Opvragen van alle abuses voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/clicks | Opvragen van alle clicks voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/deliveries | Opvragen van alle deliveries voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/errors | Opvragen van alle errors voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/impressions | Opvragen van alle impressions voor een bestemming |
GET | api.copernica.com/v2/profile/$id/ms/destinations | Opvragen van Marketing Suite destinations voor een profiel |
GET | api.copernica.com/v2/subprofile/$id/ms/destinations | Opvragen van Marketing Suite destinations voor een subprofiel |
Statistieken
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/ms/abuses | Opvragen van alle abuses |
GET | api.copernica.com/v2/ms/clicks | Opvragen van alle clicks |
GET | api.copernica.com/v2/ms/deliveries | Opvragen van alle deliveries |
GET | api.copernica.com/v2/ms/errors | Opvragen van alle errors |
GET | api.copernica.com/v2/ms/impressions | Opvragen van alle impressions |
GET | api.copernica.com/v2/ms/emailing/$id/statistics | Opvragen van statistieken voor een mailing |
GET | api.copernica.com/v2/ms/emailing/$id/abuses | Opvragen van alle abuses voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/clicks | Opvragen van alle clicks voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/deliveries | Opvragen van alle deliveries voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/errors | Opvragen van alle errors voor een emailing |
GET | api.copernica.com/v2/ms/emailing/$id/impressions | Opvragen van alle impressions voor een emailing |
GET | api.copernica.com/v2/ms/destination/$id/statistics | Opvragen van statistieken voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/abuses | Opvragen van alle abuses voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/clicks | Opvragen van alle clicks voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/deliveries | Opvragen van alle deliveries voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/errors | Opvragen van alle errors voor een bestemming |
GET | api.copernica.com/v2/ms/destination/$id/impressions | Opvragen van alle impressions voor een bestemming |
Dataverzoeken
Nadat alle data voor een dataverzoek is verzameld wordt de data voor een korte periode op de Copernica servers opgeslagen. Met de onderstaande calls kun je dataverzoeken aanmaken en de data en status van deze verzoeken opvragen.
Type | Adres | Omschrijving |
---|---|---|
POST | api.copernica.com/v2/email/$email/datarequest | Aanmaken dataverzoek voor een e-mailadres |
POST | api.copernica.com/v2/profile/$id/datarequest | Aanmaken dataverzoek voor een profiel |
POST | api.copernica.com/v2/subprofile/$id/datarequest | Aanmaken dataverzoek voor een subprofiel |
GET | api.copernica.com/v2/datarequest/$id/data | Opvragen data van een dataverzoek |
GET | api.copernica.com/v2/datarequest/$id/status | Opvragen status van een dataverzoek |
Logfiles
Copernica houdt uitgebreide data bij over alles gerelateerd aan een mailing. Je kunt alle calls gerelateerd aan logfiles in de onderstaande tabel vinden.
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/logfiles | Opvragen logfile datums |
GET | api.copernica.com/v2/logfiles | Opvragen logfile namen |
GET | api.copernica.com/v2/logfile/$filename/csv | Opvragen logfiles in CSV |
GET | api.copernica.com/v2/logfile/$filename/json | Opvragen logfiles in JSON |
GET | api.copernica.com/v2/logfile/$filename/xml | Opvragen logfiles in XML |
Webhooks
Webhooks zijn processen die hun gebruiker op de hoogte stellen van gebeurtenissen die realtime plaatsvinden via HTTP POST. Je kunt alle calls gerelateerd aan webhooks in de onderstaande tabel vinden.
Type | Adres | Omschrijving |
---|---|---|
GET | api.copernica.com/v2/webhook/$id | Opvragen van een webhook |
POST | api.copernica.com/v2/webhooks | Aanmaken van een webhook |
PUT | api.copernica.com/v2/webhook/$id | Updaten van een webhook |
DELETE | api.copernica.com/v2/webhook/$id | Verwijderen van een webhook |