Les avantages pour vous
La fonctionnalité principale du Showpad CoachRapport de API de base donne accès à Showpad Coach les ressources et les informations de rapport pour un compte Showpad autorisé. Les réponses sont au format JSON et fournissent toutes les statistiques affichées sur la page Rapports du Showpad Coach et plus encore. Il y a plusieurs façons de tirer parti de l’API Showpad Coach Reporting, notamment l’intégration à d’autres fournisseurs de services, la présentation alternatives des données Coach et l’automatisation des procédures.
Contrairement à Showpad Content, les objets Showpad Coach ne sont actuellement pas pris en charge dans l' API Explorer. Vous pouvez toujours demander des informations d'utilisateur avec l' Exporer car ces informations sont partagées entre Content et Coach et utilisent l' ID partagé de l'utilisateur.
Principales fonctionnalités.
- Exécutez des scripts pour automatiser l'extraction d'informations.
- Donne la possibilité d'intégrations supplémentaires
- Offre une flexibilité dans la façon dont les données peuvent être utilisées
Ce qu'il vous faut pour réussir
- Accès de niveau Administrateur à votre compte Showpad Coach
- Se coordonner avec un développeur en interne pour créer l'API
Apprenez comment cela fonctionne
Toutes les demandes au Showpad Coach Rapport API doit être autorisé à l'aide d'une en-tête d'autorisation spécifiant un jeton porteur unique lié à un compte Showpad.
Les jetons d'accès personnels Showpad Coach sont auto-émis par l'onglet de l’ administrateur Paramètres intégrations sur la Online Platform.
L'en-tête de la requête est formaté comme suit :
X-LearnCore-Token : {Jeton d'accès personnel}
Remarque : Bien que l'en-tête de la demande répertorie LearnCore, il s'agit également de l'en-tête correct à utiliser pour Showpad Coach.
Les demandes sont limitées à 360 demandes par heure. Dépasser cette limite entraînera une réponse d'erreur dépassée par la limite de vitesse 429.
Requêtes
URL relatifs à https://<subdomain>.Showpad.biz/API/learn/reporting/v3/json
| Méthode | Requête HTTP | Description |
|---|---|---|
| objet |
Obtenir / objets |
Listez tous les objets possibles. |
| décrire | OBTENIR /objets/objectId/décrire |
Décrire les champs et les types de données dans un objet. |
| résultat | Obtenir/objets/objectId | Recevoir des résultats d'objets paginés à partir d'une requête. |
Objet
Obtenir https://<subdomain>.Showpad.biz/API/learn/reporting/v3/JSON/objects
Ne fournissez pas de paramètres de requête avec cette méthode. Une demande acceptée répondra avec un statut 200 OK et une réponse d' Object dans le corps de la réponse.
Décrire
Obtenir https://<subdomain>.Showpad.biz/API/learn/reporting/v3/JSON/object/objectID/describe
Ne fourni pas de paramètres de requête avec cette méthode. Une demande acceptée répondra avec un statut 200 OK et une réponse Describe dans le corps de la réponse.
Résultat
Obtenir https://<subdomain>.Showpad.biz/API/learn/reporting/v3/JSON/objects/objectId
Paramètres de demande
Paramètres de Parcours
| Le nom du paramètre | Valeur | Description |
|---|---|---|
| paramètres |
chaîne |
JSON codé en Base64 représentant les paramètres demandés |
Une demande acceptée répondra avec un statut 200 OK et un Résultat de réponse dans le corps de la réponse.
Réponses
Objet
{
"objets" : [
{
"id" : chaîne,
"displayName" : chaîne,
"urls" : {
"décrire" : chaîne,
"objet" : chaîne
}
}
]
}
| Nom de la propriété | Valeur | Description |
|---|---|---|
| objets |
liste |
Liste des types de rapports disponibles |
| objets [].id | chaîne | L'identifiant API de l'objet |
| objets []. Afficher un nom | chaîne | Le nom d'affichage de l'objet |
| objets []. urls.décrire | chaîne | Le Parcours de l'URL pour décrire les champs de l'objet |
{
"des champs" : [
{
"id" : chaîne,
"displayName" : chaîne,
"type" : chaîne,
"options" : [chaîne]
}
]
}
| Nom de la propriété | Valeur | Description |
|---|---|---|
| des champs |
liste |
Liste des champs disponibles pour l'objet choisi |
| champs [].id | chaîne | L'identifiant de l'API du champ |
| des champs []. Afficher un nom | chaîne | Le nom d'affichage du champ |
|
champs [].type |
chaîne | Ils tapent la valeur qui est stockée dans le champ. Les valeurs possibles sont : int, picklist, string, float, pourcentage et date |
|
champs [].options |
liste | Les options disponibles pour les listes de sélection. * Disponible uniquement pour les champs de type liste de choix. |
Résultat
{
"totalResults" : int,
"pageResults" :: int,
"timeStamp" :: date,
"paramètres" : {
"page" : int,
"resultsPerPage" : int,
"filtres" : [
{
],
"champs" : [chaîne]
"Trier" : {
"champ" : chaîne
"direction" : chaîne
}
},
"records" : [
{
champ : fieldType,
...
}
]
}
| Nom de la propriété | Valeur | Description |
|---|---|---|
| totalResults |
int |
Le nombre total de résultats en fonction des paramètres de la requête |
| pageRésultats | int | Le nombre de résultats sur la page en cours |
| Horodatage | Date | Horodatage du dernier calcul des données |
|
paramètres.page |
int | La page demandée |
|
paramètres. résultatspParPage |
int | Le nombre total de résultats par page |
|
paramètres. filtres []. champ |
chaîne | Le champ utilisé pour un filtre |
|
paramètres. filtres []. opérateur |
chaîne | Opérateur défini par l'utilisateur pour un filtre. * Les valeurs possibles pour les opérateurs varient en fonction du type de champ |
|
paramètres. filtres [] valeurs |
chaîne | La liste des valeurs utilisées pour filtrer un champ. Le type de champ est variable en fonction du champ |
|
paramètres.fields |
liste | La liste des champs à inclure dans le résultat |
|
paramètres. sort.field |
chaîne | Le champ choisi pour le tri |
|
paramètres. sort.direction |
chaîne | La direction du genre. Les valeurs possibles sont : asc ou desc |
|
enregistrements []. champ |
type de champ | Un enregistrement individuel pour les données demandées. Le domaine Type est variable en fonction du champ. |
Création de paramètres pour la demande de résultats
Format
{
"page" : int,
"résultats par page" : int,
"filtres" : [
{
"champ" : chaîne,
"opérateur" : chaîne,
"valeurs" : [fieldType]
}
],
"champs" : [chaîne]
"Trier" : {
"champ" : chaîne,
"direction" : chaîne
}
}
| Nom de la propriété | Valeur | Description |
|---|---|---|
| page |
int |
La page demandée |
| resultsPerPage | int | Définissez le nombre total de résultats par page. * Doit être compris entre 1 et 500 |
| filtres [].champ | chaîne | Le champ utilisé pour un filtre |
|
filtres [].opérateur |
chaîne | Opérateur défini par l'utilisateur pour un filtre. Les valeurs possibles pour les opérateurs varient en fonction du type de champ. |
|
filtres [] valeurs |
liste | La liste des valeurs utilisées pour filtrer un champ. La variable fieldType est basée sur le champ |
|
des champs |
liste | La liste des champs à inclure dans le résultat. |
|
sort.field |
chaîne | Le champ choisi pour le tri |
|
sort.direction |
chaîne | La direction du genre. Les valeurs possibles sont asc ou desc |
Toutes les demandes effectuées sans paramètres spécifiques seront définies sur les valeurs par défaut. Une fois les paramètres définis, codez le JSON en base64 et transmettez-le sous forme de "paramètres" dans la chaîne de requête.
Les opérateurs
| Opérateur | Description | Types de champs disponibles | Nombre de valeurs |
|---|---|---|---|
| eq |
Égal à |
chaîne, int, float, pourcentage, date |
1 |
| ne | Pas égal à | chaîne, int, float, pourcentage, date | 1 |
| co | Contient | chaîne | 1 |
|
bw |
Commence par | chaîne | 1 |
|
nc |
Ne contient pas | chaîne | 1 |
|
dans |
In | liste de sélection | Au moins 1 |
|
C'est |
Moins que | int, float, pourcentage, date | 1 |
|
le |
Inférieur ou égal à | int, float, pourcent, date | 1 |
|
gt |
Plus grand que | int, float, pourcent, date | 1 |
|
ge |
Plus grand ou égal à | int, float, pourcent, date | 1 |
|
être |
Entre | int, float, pourcent, date | 2 |
|
nb |
Pas entre | int, float, pourcent, date | 2 |
Exemple de demande
Les paramètres ci-dessous renverront les 100 premiers curriculums avec le titre « Exemple de curriculum», triés par ordre croissant du titre du curriculum.
{
" Page '' : 1
"résultats par page" : 100
"filtres" : [
{
"field" : "curriculumTitle"
"opérateur" : "eq"
"valeurs" : [
"Exemple de curriculum",
]
}
],
"des champs" : [
"curriculumTitle",
"courseCount",
"userCount",
"startCount",
"startPercentage",
"testAverage",
"pitchAverage"
],
"Trier" : {
"field" : "curriculumTitle",
"direction" : "asc"
}
}
Exemple de demande cURL
curl -H "Jeton X-LearnCore : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
https : // < sous-domaine >.Showpad.biz / API / learn / reporting / v3 / JSON / object / curriculum?paramètres =
eyJyZXNlbHRzUGVyUGFnZSI6lDUsDQogInBhZ2UiOjIsDQogImZpbHRlcnMiOlt7lmZpZWx
kIjoiY3VycmljdWxlbVRpdGxlliwib3BlcmFOb3liOiJjbylsInZhbHVlljoiZSJSLA0KIC
B7ImZpZWxkljoiY2SlcnNlQ2SlbnQiLCJvcGVyYXRvcil6ImJlIiwidmFsdWUiOjAsInZhb
HVlMi16NTN5XSwNCiJmaWVsZHMiOiBbDQogICJjdXJyaWNlbHVtVG10bGUiLA0KICAidXNl
ckNvdW50liwNCiAgInN0YXJ0Q2SlbnQiLA0KICAic3RhcnRQZXJjZW50YWdlliwNCiAgInR
lc3RBdmVyYWdlliwNCiAgInBpdGNoQXZlcmFnZSJdLAOKInNvcnQiOnsiZmllbGQiOiJzdG
FydFBlcmNlbnRhZ2UiLCJkaXJlY3Rpb24iOiJkZXNjInONCnO
