Reporting Service

API V2 reference

This page applies to SCORM Cloud API V2. If you're looking for our V1 api reference see here

Reporting Service


This service provides a set of methods for accessing information about or owned by the account designated by the appid, and ties in with the Reportage reporting application. For more information about accessing Reportage, check out the Reportage Integration Documentation.


getAccountInfo

GET /reporting/accountInfo

Summary

Get all of the account information specified by the given app ID

Responses:

Produces: application/json

HTTP Code Description Schema
200 ReportageAccountInfoSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:reporting




getReportageAuthToken

GET /reporting/reportageAuth

Summary

Get a session authentication token to use when launching Reportage

Parameters

Consumes: application/json

Type Name Required Schema
Query navPermission true String
Query admin false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 The authentication token to use when launching a Reportage session ReportageAuthTokenSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:reporting




getReportageLink

GET /reporting/reportageLink

Summary

Get the link to a page in Reportage with the given authentication and permissions

Parameters

Consumes: application/json

Type Name Required Schema
Query auth true String
Query reportUrl true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The authenticated link to the specified Reportage page ReportageLinkSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:reporting