Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

AI OnAI Off

Episerver Profile Store Rest API 2.0

Episerver Profile Store Rest API 2.0

Blacklists

GET​/api​/v2.0​/Blacklists
Gets blacklists based on OData syntax query.
POST​/api​/v2.0​/Blacklists
Creates a new blacklist.
DELETE​/api​/v2.0​/Blacklists​/{id}
Deletes a blacklist.
DELETE​/api​/v2.0​/Blacklists​/{id}​/clearuserdata
Deletes all customer data from a blacklist.

FilterDefinitions

GET​/api​/v2.0​/FilterDefinitions
Get all filter definitions.
POST​/api​/v2.0​/FilterDefinitions
Create a filter definition.
GET​/api​/v2.0​/FilterDefinitions​/{id}
Get a filter definition by id.
PUT​/api​/v2.0​/FilterDefinitions​/{id}
Update a filter definition.
DELETE​/api​/v2.0​/FilterDefinitions​/{id}
Delete a filter definition.
POST​/api​/v2.0​/FilterDefinitions​/{id}​/preview
Preview track events matching a filter definition.

Profiles

GET​/api​/v2.0​/Profiles​/{scope}​/{id}
Gets profile by id.
DELETE​/api​/v2.0​/Profiles​/{scope}​/{id}
Deletes profiles and associated track events.
POST​/api​/v2.0​/Profiles
Creates a new profile.
GET​/api​/v2.0​/Profiles
Gets profiles based on OData syntax query.
PUT​/api​/v2.0​/Profiles​/{id}
Replaces an existing profile, or creates a new profile if no profile with the supplied id exists.

Scopes

PUT​/api​/v2.0​/Scopes​/{id}
Replaces an existing scope, or creates a new scope if no scope with the supplied id exists.
GET​/api​/v2.0​/Scopes​/{id}
Gets scope by scope id.
GET​/api​/v2.0​/Scopes
Gets all scopes.

Segments

GET​/api​/v2.0​/Segments
Gets segments version 2 based on OData syntax query.
POST​/api​/v2.0​/Segments
Creates a new segment.
GET​/api​/v2.0​/Segments​/{id}
Gets segment information.
PUT​/api​/v2.0​/Segments​/{id}
Replaces an existing segment, or creates a new segment if no segment with the supplied id exists.
POST​/api​/v2.0​/Segments​/preview
Preview a result of segment with FilterDefinition.
POST​/api​/v2.0​/Segments​/{id}​/MatchByProfileId
Verifies list profile id and return profiles match this segment.
POST​/api​/v2.0​/Segments​/{id}​/MatchByEmail
Verifies list profile email and return profiles match this segment.

TrackEvents

GET​/api​/v2.0​/TrackEvents
Gets track events based on OData syntax query.
DELETE​/api​/v2.0​/TrackEvents​/{scope}​/{id}
Delete track event based on scope and Id.
POST​/api​/v2.0​/TrackEvents​/preview
Execute a KQL query to preview a subset of events data, maximum of 1000 query results.

Schemas

ErrorDetail
ErrorResponse
BlacklistResult
BlacklistResultSearchResult
BlacklistRequest
OkResponse
FilterDefinitionType
FilterDefinitionResult
FilterDefinitionResultSearchResult
FilterDefinitionPostRequest
FilterDefinitionPutRequest
FilterDefinitionPreviewRequest
StringObjectIDictionarySearchResult
ProfileResult
ProfileRequest
ProfileResultSearchResult
ScopeRequest
ScopeResult
IProfileFilter
SegmentFilterType
SegmentTimeFilter
ComparisionOperator
SegmentOccurrenceFilter
SegmentFilterResult
SegmentFilterCollectionResult
SegmentResult
SegmentResultSearchResult
SegmentFilterRequest
SegmentFilterCollectionRequest
SegmentRequest
SortOrder
SortOptionRequest
SegmentPreviewRequest
ExportProfileModel
UserDataResult
TrackEventResult
TrackEventResultSearchResult
TrackEventPreviewRequest