The REST API allows you to retrieve and update the data that is stored inside Copernica from out of your own website or app. You can write your own scripts that send requests and instructions to our servers to fetch this data or to update it. You can use this API to automatically synchronize the data in Copernica with your own system, without any human interference.

REST API: method reference

The following table lists all methods that are accessible through HTTP GET, POST, PUT en DELETE:

Method Address Description
GET Fetch API access token identity
GET Fetch databases
POST Create a new database
GET$id Fetch database settings
PUT$id Modify database settings
DELETE$id Remove a database
GET$id/unsubscribe Fetch unsubscribe behavior
PUT$id/unsubscribe Set unsubscribe behavior
GET$id/fields Fetch database fields
POST$id/fields Create database field
PUT$id/field/$id Edit database field
DELETE$id/field/$id Remove database field
GET$id/interests Fetch interests
POST$id/interests Create interest
GET$id/collections Fetch collections
POST$id/collections Create collection
GET$id/profiles Fetch profiles
POST$id/profiles Create new profile
PUT$id/profiles Edit multiple profiles
GET$id/profileids Fetch profile identifiers
GET$id/views Fetch selections
POST$id/views Create new selection
GET$id Fetch selection data
PUT$id Update selection data
DELETE$id Remove selection
GET$id/profiles Fetch profiles from selection
GET$id/profileids Fetch profile identifiers
GET$id/rules Fetch selection rules
POST$id/rules Create selection rules
GET$id/rule/$id Fetch selection rule
GET$id/views Fetch nested selections
POST$id/views Create a nested selection
GET$id Fetch selection rule
PUT$id Edit selection rule
DELETE$id Remove selection rule
GET$id/conditions Get selection conditions
POST$id/conditions Create a selection condition
GET$id Fetch profile data
PUT$id Edit profile data
DELETE$id Remove profile
GET$id/fields Fetch profile fields
PUT$id/fields Edit profile fields
GET$id/interests Fetch profile interests
POST$id/interests Add interests to profile
PUT$id/interests Edit profile interests
GET$id/subprofiles Fetch subprofiles of a profile
POST$id/subprofiles Create subprofile
GET$id Fetch collection data
PUT$id Edit collection data
GET$id/fields Fetch collection fields
POST$id/fields Create collection field
PUT api.copernica/com/v1/collection/$id/field/$id Edit collection field
DELETE$id/field/$id Remove collection field
GET$id/miniviews Fetch miniviews
POST$id/miniviews Create miniview
GET$id/subprofiles Fetch subprofiles from a collection
GET$id/subprofileids Fetch subprofile IDs from a collection
GET$id/unsubscribe Fetch collection unsubscribe behavior
PUT$id/unsubscribe Update collection unsubscribe behavior
GET$id Fetch miniview data
PUT$id Update miniview data
DELETE$id Remove miniview
GET$id/subprofiles Fetch subprofiles in a miniview
GET$id/subprofileids Fetch subprofile identifiers
GET$id/rules Fetch miniview rules
POST$id/rules Create miniview rule
GET$id/rule/$id Fetch miniview rule
GET$id Fetch miniselection rule
PUT$id Edit miniselection rule
DELETE$id Remove miniselection rule
GET$id/conditions Fetch conditions for a miniselection
POST$id/conditions Create condition for a miniselection
GET$id Fetch subprofile data
GET$id/fields Fetch subprofile fields
GET Fetch all logfiles
GET$date Logfile names
GET$name Download logfile in CSV format
GET$name/json Download logfile in JSON format
GET$name/xml Download logfile in XML format