Data Access

Overview

This functionality allows you to access/export all xApi statements that exist for the users of your organisation.

You must have a Reveal API Key to access this data.

Example API Key: Reveal_AK-xoi3ypiFGaWfRRIQq5Q2tCfa7bMUDbUEBr6jJNnf8mQYzW4ebdXchj

Request

Endpoint

https://reveal.services.skillstown.com/v1/external-data-access/statements

Headers

All headers are required when sending a request.

Key	Value
Authorization	YOUR_API_KEY
Accept	application/json

Query parameters

All query parameters are required when sending a request.

Key	Value
pageSize	(min) 1 to (max) 100
pageNumber	1 - n

Response

{
  items: Statement[];
  page: number;
  pageSize: number;
  totalItems: number;
  hasNext: boolean;
  hasPrevious: boolean;
  metaData: null;
}

Key	Value	Description
items	Statement[]	An array of xApi statements
page	number	The current page number
pageSize	number	The number of items returned per-page
hasNext	boolean	Whether or not there is a next page for the current query
hasPrevious	boolean	Whether or not there is a previous page for the current query
metaData	null	Unused - will always return null