Data Management — API Reference

Gather and manage data from all of your touchpoints and use it in our Analytics Suite or retrieve it for use in other services.

145 endpoints across 9 tags.

Events

• POST /v4/transactions — Create a transaction
• POST /v4/transactions/batch — Batch add or update transactions
• GET /v4/events/by-client/{clientId} — Get Profile events as Workspace (deprecated)
• GET /v4/events — Get Profile's own events (deprecated)
• POST /v4/events/application-started — Application started
• POST /v4/events/registered — Profile account registered
• POST /v4/events/logged-in — Profile logged in
• POST /v4/events/logged-out — Profile logged out
• POST /v4/events/added-to-cart — Item added to cart
• POST /v4/events/removed-from-cart — Item removed from cart
• POST /v4/events/added-to-favorites — Product added to favorites
• POST /v4/events/product-view — Item viewed
• POST /v4/events/assigned-to-company — Profile assigned to company
• POST /v4/events/appeared-in-location — Profile logged location
• POST /v4/events/push/received — Push notification received
• POST /v4/events/push/viewed — Push notification viewed
• POST /v4/events/push/clicked — Push notification clicked
• POST /v4/events/push/cancelled — Push notifications cancelled
• POST /v4/events/cancelled-transaction — Transaction cancelled
• POST /v4/events/hit-timer — Timer hit
• POST /v4/events/searched — Search requested
• POST /v4/events/shared — Content shared
• POST /v4/events/recommendation-seen — Recommendation viewed (deprecated)
• POST /v4/events/recommendation-click — Recommendation clicked (deprecated)
• POST /v4/events/visited-screen — Mobile app screen visited
• POST /v4/events/custom — Custom event
• POST /v4/events/batch — Batch send events
• GET /v4/server/time — Get server time
• POST /v4/events/recommendation-view — Recommendation viewed
• POST /v4/events/item-search-click — Search result clicked

AI Events

• POST /v4/events/ai-compat/batch — Batch upload AI events
• POST /v4/events/ai-compat/item.search.click — Item clicked in search
• POST /v4/events/ai-compat/suggestion.search.click — Suggestion clicked in search
• POST /v4/events/ai-compat/product.search.click — Product clicked in search (deprecated)
• POST /v4/events/ai-compat/recommendation.click — Item clicked in recommendation
• POST /v4/events/ai-compat/recommendation.view — Recommendation viewed

Activities

• GET /activities-api/activities/{clientId} — Get profile activities (deprecated)
• POST /activities-api/activity/by/{identifierType} — Get a single activity (deprecated)
• GET /activities-api/descriptions — Get description mappings
• POST /activities-api/descriptions — Add description mapping
• POST /activities-api/descriptions/{descriptionId} — Update description mapping
• GET /activities-api/labels — Get label mappings
• POST /activities-api/labels — Add label mapping
• POST /activities-api/labels/{labelId} — Update label mapping
• GET /activities-api/icons — Get icon mappings
• POST /activities-api/icons — Add icon mapping
• POST /activities-api/icons/{iconID} — Update icon mapping
• GET /activities-api/events — Get profile's own events
• POST /activities-api/events/by/{identifierType} — Get profile events as a workspace/Synerise user
• GET /activities-api/v2/descriptions — Get description mappings
• POST /activities-api/v2/descriptions — Add description mapping
• GET /activities-api/v2/labels — Get label mappings
• POST /activities-api/v2/labels — Add label
• GET /activities-api/v2/icons — Get icons for bp
• POST /activities-api/v2/icons — Add icon mapping

Catalogs

• GET /catalogs/bags/{catalogId}/csv — Get all items as CSV file
• POST /catalogs/bags/{catalogId}/items/upload — Add items from CSV
• GET /catalogs/bags — Get catalogs
• POST /catalogs/bags — Add catalog
• DELETE /catalogs/bags — Delete catalogs
• GET /catalogs/bags/{catalogId}/keys — Get catalog keys
• GET /catalogs/bags/{catalogId} — Get catalog info
• DELETE /catalogs/bags/{catalogId} — Delete catalog
• GET /catalogs/bags/{catalogId}/items — Get items from catalog
• POST /catalogs/bags/{catalogId}/items — Add item
• POST /catalogs/bags/{catalogId}/items/batch — Batch add items
• PATCH /catalogs/bags/{catalogId}/enrichment/fields — Update enrichment fields
• GET /catalogs/bags/{catalogId}/items/itemKey/{itemKey} — Get single item by itemKey
• DELETE /catalogs/bags/{catalogId}/items/itemKey/{itemKey} — Delete single item by itemKey
• GET /catalogs/bags/{catalogId}/items/{itemId} — Get single item by database ID
• POST /catalogs/bags/{catalogId}/items/{itemId} — Update single item by database ID
• DELETE /catalogs/bags/{catalogId}/items/{itemId} — Delete single item by database ID
• GET /catalogs/items — Get all items
• POST /catalogs/bags/{catalogId}/mappings — Add mapping
• GET /catalogs/mappings — Get all mappings
• DELETE /catalogs/mappings/{bpActionParamKey} — Delete mapping
• GET /catalogs/itemDetail — Get single item by unique key
• DELETE /catalogs/v2/bags/{catalogId}/items — Delete all items from a catalog
• DELETE /catalogs/v2/bags/{catalogId}/items/batch — Delete items by itemKeys
• PATCH /catalogs/v2/bags/{catalogId}/enable/filtering — Enable filtering
• PATCH /catalogs/v2/bags/{catalogId}/disable/filtering — Disable filtering
• POST /catalogs/v1/async/bags/{catalogId}/item — Add or update item asynchronously
• PATCH /catalogs/v1/async/bags/{catalogId}/item — Add or update (partial) item asynchronously
• POST /catalogs/v1/async/bags/{catalogId}/items — Batch add or update items asynchronously
• PATCH /catalogs/v1/async/bags/{catalogId}/items — Batch add or update (partial) items asynchronously

Asset tags

• GET /tags-collector/directories — Get all directories
• POST /tags-collector/directories — Create directory
• GET /tags-collector/directories/types — Get directory types
• POST /tags-collector/directories/types — Create directory type
• PATCH /tags-collector/directories/{directoryHash} — Update directory
• DELETE /tags-collector/directories/{directoryHash} — Delete directory
• GET /tags-collector/directories/{directoryHash}/tags — Get tags from directory
• POST /tags-collector/directories/{directoryHash}/tags — Assign tags to directory
• DELETE /tags-collector/directories/{directoryHash}/tags — Unassign tags from directory
• PUT /tags-collector/directories/{directoryHash}/types — Update directory type
• GET /tags-collector/tags — Get tag list
• POST /tags-collector/tags — Create tag
• PATCH /tags-collector/tags/{tagHash} — Update tag

Tags

• GET /v4/clients/tags — Get all tags
• POST /v4/tags — Create a tag
• PUT /v4/tags/{tagID} — Update a tag
• DELETE /v4/tags/{tagID} — Remove a tag
• GET /v4/clients/{clientId}/tags — Get profile tags
• POST /v4/clients/{clientId}/tags/{tagID} — Assign tag to profile
• DELETE /v4/clients/{clientId}/tags/{tagID} — Remove tag from profile

Profile management

• POST /v4/clients — Create a Profile
• POST /v4/clients/merge/from/custom-ids/{sourceCustomIDs}/to/custom-id/{targetCustomID} — Merge profiles by customId
• POST /v4/clients/merge/from/ids/{fromClientIds}/to/id/{toClientId} — Merge profiles by clientId
• POST /v4/clients/batch — Batch add or update profiles
• GET /v4/clients/{clientId} — Get profile data
• POST /v4/clients/{clientId} — Update a profile (identify by ID)
• DELETE /v4/clients/{clientId} — Delete a profile
• POST /v4/clients/by-email/{clientEmail} — Update a profile (identify by email)
• POST /v4/clients/by-customid/{customId} — Update a profile (identify by customId)
• DELETE /v4/clients/by-custom-id/{customId} — Delete a profile (identify by customId)
• GET /v4/clients/{identifierType}/{identifierValue} — Fetch profile data
• GET /v4/clients/batch/by-phone/{phoneNumber} — Batch fetch profiles by phone number
• GET /crm/v1/clients/{clientId}/contacts — Get Profile details
• PUT /crm/v1/contacts/{clientId} — Update Profile
• POST /morph/exports/clients/segmentation — Create and run profile export
• GET /morph/exports/clients/{taskId}/status — Check profile export status
• GET /morph/exports/clients/{taskId}/data — Get exported profiles
• GET /notes-service/by-id/{clientId} — Get all Profile notes
• POST /notes-service/by-id/{clientId} — Create a note
• GET /notes-service/by-id/{clientId}/{noteId} — Get note
• PUT /notes-service/by-id/{clientId}/{noteId} — Update note
• DELETE /notes-service/by-id/{clientId}/{noteId} — Delete note
• POST /sauth/management/client/{clientID}/logout — Log out a Profile

Analytics: Expressions

• POST /analytics/{namespace}/expressions/visible-for-client/by/{identifierType} — Get expressions for profile card
• POST /analytics/{namespace}/expressions/{expressionId}/calculate/by/{identifierType} — Calculate expression for profile
• GET /analytics/{namespace}/expressions — List expressions
• POST /analytics/{namespace}/expressions — Create expression
• GET /analytics/{namespace}/expressions/{expressionId} — Get expression details
• PUT /analytics/{namespace}/expressions/{expressionId} — Update expression
• DELETE /analytics/{namespace}/expressions/{expressionId} — Delete expression
• POST /analytics/{namespace}/expressions/preview/by/{identifierType} — Get expression preview

Analytics: Aggregates

• POST /analytics/analytics/definitions-manager/aggregates/{aggregateId}/client/{clientId}/calculate/histogram — Calculate aggregate for profile with period conditions
• POST /analytics/{namespace}/aggregates/preview/by/{identifierType} — Get aggregate preview
• POST /analytics/{namespace}/aggregates/visible-for-client/by/{identifierType} — Get aggregates for profile card
• POST /analytics/{namespace}/aggregates/{aggregateId}/calculate/by/{identifierType} — Calculate aggregate for profile
• GET /analytics/{namespace}/aggregates — List aggregates
• POST /analytics/{namespace}/aggregates — Create aggregate
• GET /analytics/{namespace}/aggregates/{aggregateId} — Get aggregate details
• PUT /analytics/{namespace}/aggregates/{aggregateId} — Update aggregate
• DELETE /analytics/{namespace}/aggregates/{aggregateId} — Delete aggregate

Back to all API categories