SkyPoint Cloud

SkyPoint is a customer data platform that champions privacy and compliance through connected privacy-first customer experiences. SkyPoint Connector provides a set of APIs to work with SkyPoint platform instances and entities.

Status: Preview

Tier: Premium

Version: 1.0

Actions:

Name	Summary
GetEntities (string tenantId, string instanceId, [internal]string $select, [internal][Optional]string $filter)	Get Entities
GetItems (string tenantId, string instanceId, string entityName, [advanced][Optional]string $select, [advanced][Optional]string $filter, [advanced][Optional]string top, [advanced][Optional]string skip)	Get items from an entity
GetItem (string tenantId, string instanceId, string entityName, string itemId)	Get item of an entitiy
DeleteWebhook (string instanceId, string webhookId)	Delete webhook
GetTenants ([internal]string $select)	Get All Tenants
GetInstances (string tenantId, [internal]string $select)	Get All Instances of the Tenant

Triggers:

Name	Summary
GetOnDataflowRefreshComplete (string tenantId, string instanceId, GetOnDataflowRefreshCompleteParameterBody body)	When a dataflow refresh is completed
GetOnDataflowRefreshFail (string tenantId, string instanceId, GetOnDataflowRefreshFailParameterBody body)	When a dataflow refresh is failed

Objects:

Name	Summary
DeleteWebhookResponse
GetEntitiesResponseItem
GetInstancesResponseItem
GetItemResponse
GetItemsResponse
GetOnDataflowRefreshCompleteParameterBody
GetOnDataflowRefreshFailParameterBody
GetTenantsResponseItem

Actions:

GetEntities

Summary: Get Entities

Description: This operation gets entities from an instance

Syntax:

SkyPointCloud.GetEntities (string tenantId, string instanceId, [internal]string $select, [internal][Optional]string $filter)

Parameters:

Name	Type	Summary	Required	Related Action
tenantId	string (Tenant Id)	Identifier of a tenant	True	GetTenants
instanceId	string (Instance Id)	Identifier of an instance	True	GetInstances
$select	string		True
$filter	string		False

Returns:

Type:array of (GetEntitiesResponseItem)

GetItems

Summary: Get items from an entity

Description: This operation gets items from an entity

Syntax:

SkyPointCloud.GetItems (string tenantId, string instanceId, string entityName, [advanced][Optional]string $select, [advanced][Optional]string $filter, [advanced][Optional]string top, [advanced][Optional]string skip)

Parameters:

Name	Type	Summary	Required	Related Action
tenantId	string (Tenant Id)	Identifier of a tenant	True	GetTenants
instanceId	string (Instance Id)	Identifier of an instance	True	GetInstances
entityName	string (Entity name)	Name of an entity	True	GetEntities
$select	string (Select Query)	Specific fields to retrieve from entries (default = all)	False
$filter	string (Filter Query)	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	False
top	string (Top Count)	Total number of entries to retrieve (default = 100).	False
skip	string (Skip Count)	The number of entries to skip (default = 0).	False

Returns:

Type:GetItemsResponse

GetItem

Summary: Get item of an entitiy

Description: This operation gets an item from an entity

Syntax:

SkyPointCloud.GetItem (string tenantId, string instanceId, string entityName, string itemId)

Parameters:

Name	Type	Summary	Required	Related Action
tenantId	string (Tenant Id)	Identifier of a tenant	True	GetTenants
instanceId	string (Instance Id)	Identifier of an instance	True	GetInstances
entityName	string (Entity name)	Name of an entity	True	GetEntities
itemId	string (Item id)	Identifier for the item	True

Returns:

Type:GetItemResponse

DeleteWebhook

Summary: Delete webhook

Description: Deletes a webhook

Syntax:

SkyPointCloud.DeleteWebhook (string instanceId, string webhookId)

Parameters:

Name

Type

Summary

Required

Related Action

instanceId

string

True

webhookId

string

True

Returns:

Type:DeleteWebhookResponse

GetTenants

Summary: Get All Tenants

Description: This operation retrieves all tenants

Syntax:

SkyPointCloud.GetTenants ([internal]string $select)

Parameters:

Name

Type

Summary

Required

Related Action

$select

string

True

Returns:

Type:array of (GetTenantsResponseItem)

GetInstances

Summary: Get All Instances of the Tenant

Description: This operation gets available instances of the tenant

Syntax:

SkyPointCloud.GetInstances (string tenantId, [internal]string $select)

Parameters:

Name

Type

Summary

Required

Related Action

tenantId

string

True

GetTenants

$select

string

True

Returns:

Type:array of (GetInstancesResponseItem)

Triggers:

Trigger GetOnDataflowRefreshComplete

Summary: When a dataflow refresh is completed

Description: Endpoint for notifications when a dataflow refresh is completed.

Syntax:

SkyPointCloud.GetOnDataflowRefreshComplete (string tenantId, string instanceId, GetOnDataflowRefreshCompleteParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
tenantId	string (Tenant Id)	Identifier of a tenant	True	GetTenants
instanceId	string (Instance Id)	Identifier of an instance	True	GetInstances
body	GetOnDataflowRefreshCompleteParameterBody		True

Returns:

Trigger GetOnDataflowRefreshFail

Summary: When a dataflow refresh is failed

Description: Endpoint for notifications when a dataflow refresh is failed.

Syntax:

SkyPointCloud.GetOnDataflowRefreshFail (string tenantId, string instanceId, GetOnDataflowRefreshFailParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
tenantId	string (Tenant Id)	Identifier of a tenant	True	GetTenants
instanceId	string (Instance Id)	Identifier of an instance	True	GetInstances
body	GetOnDataflowRefreshFailParameterBody		True

Returns:

DeleteWebhookResponse

Summary:

Description:

Properties:

Name

Type

Summary

GetEntitiesResponseItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string	id
name	string	name
description	string	description
sourceName	string	sourceName
attributes	array of (AttributesItem)	attributes
groupId	string	groupId
objectId	string	objectId
createdBy	string	createdBy
annotations	array of (AnnotationsItem)	annotations
partitions	array of (PartitionsItem)	partitions
schemaDescription	string	schemaDescription
modifiedTime	string	modifiedTime

AttributesItem

Summary:

Description:

Properties:

Name

Type

Summary

name

string

name

datatype

string

datatype

AnnotationsItem

Summary:

Description:

Properties:

Name

Type

Summary

name

string

name

value

string

value

PartitionsItem

Summary:

Description:

Properties:

Name

Type

Summary

name

string

name

refreshtime

string

refreshtime

GetInstancesResponseItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string	id
name	string	name
displayname	string	displayname

GetItemResponse

Summary:

Description:

Properties:

Name

Type

Summary

GetItemsResponse

Summary:

Description:

Properties:

Name

Type

Summary

GetOnDataflowRefreshCompleteParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

Events

array of (string)

Events

Url

string

Url

GetOnDataflowRefreshFailParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

Events

array of (string)

Events

Url

string

Url

GetTenantsResponseItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string	id
name	string	name
businessname	string	businessname