Data management clients

Sitefinity Insight administrators use data management clients to work with contacts’ data stored in Sitefinity Insight. Thus, Sitefinity Insight visitors, both anonymous and registered contacts, can employ their “right to erasure (or right to be forgotten)” and “right of access.” Sitefinity Insight completes these requests via the ContactDeleteRequestClient and the ContactExportRequestClient, respectively.

NOTE: For consistency, the examples in this article use "contacts" to describe both anonymous visitors and registered contacts, who request their data exported or deleted.

The following article lists Sitefinity Insight .NET SDK clients, along with their constructors, methods, and sample code.

Constructors

• public ContactDeleteRequestClient(IAccessToken accessToken, string datacenterKey)
  Initializes a new instance of the ContactDeleteRequestClient class using authorization token and datacenter API key.
  
• public ContactDeleteRequestClient(IAccessToken accessToken, string serverAddress, string datacenterKey)
  Initializes a new instance of the ContactDeleteRequestClient class using authorization token, Sitefinity Insight API server address, and datacenter API key.
  

  NOTE: This constructor is obsoleted and will be removed in a future version of the SDK. Consider using the constructor overload which accepts only authorization token and datacenter key. For more information, see Capture server side data with .NET SDK.

Methods

• public Task<IEnumerable<ContactDeleteRequest>> GetAll(LoadOptions loadOptions)
  Gets all delete requests.

• public Task<ContactDeleteRequest> GetById(int id)
  Gets a contact delete request by identifier.
• public Task<ContactDeleteRequest> CreateDeleteRequest(IEnumerable<SubjectId> subjectIds)
  Creates a delete request.

Constructors

• public ContactExportRequestClient(IAccessToken accessToken, string datacenterKey) : base(accessToken, datacenterKey)
  Initializes a new instance of the ContactExportRequestClient class using authorization token and datacenter API key.
  
• public ContactExportRequestClient(IAccessToken accessToken, string serverAddress, string datacenterKey)
  Initializes a new instance of the ContactExportRequestClient class using authorization token, Sitefinity Insight API server address, and datacenter API key.
  

  NOTE: This constructor is obsoleted and will be removed in a future version of the SDK. Consider using the constructor overload which accepts only authorization token and datacenter key. For more information, see Capture server side data with .NET SDK.

Methods

• public Task<IEnumerable<ContactExportRequest>> GetAllExportRequests(LoadOptions loadOptions)
  Gets all of the data export requests for the datacenter with which the client has been instantiated.
  
• public Task<ContactExportRequest> GetExportRequestById(int id)
  Gets a data export request by its identifier.
  
• public Task<ContactExportRequest> CreateExportRequest(IEnumerable<SubjectId> subjectIds)
  Creates a new data export request.
  
• public Task<Stream> DownloadExportedData(int exportRequestId)
  Downloads the exported data.