Litmos Support

Getting Started
Knowledgebase
Community

Articles in this section

See more

Date Range API's

Avatar
Steve Cunha
  • Updated
Follow

Included here is a set of API's that will return a list of associated records within a given date range. The date range difference must be equivalent to or less than 7 days. 

Important Notes: The date range format will be 'YYYY-MM-DD' for the "since" and "to" parameters, and in response, all records that were created/updated between 'YYYY-MM-DD 00:00:00' to 'YYYY-MM-DD 00:00:00' will be returned. This means records created "today" won't be returned in the response unless the "to" parameter contains a future date. 

By default, all API responses will return 100 results. You can return up to 1,000 records by adding the 'limit' query parameter to your URI. Please visit our 'Overview Developer API' documentation and refer to the 'Search & Paging Parameters' section for pagination, and other query parameters you can use. 

Get User Details 

Returns a list of people including 'active' and 'inactive' people that have been created or updated within a given date range.

Request Uri

GET /org/users/details?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<Users>
 <User>
 <Id></Id>
 <UserName></UserName>
 <FirstName></FirstName>
 <LastName></LastName>
 <FullName></FullName>
 <Email></Email>
 <AccessLevel></AccessLevel>
 <DisableMessages></DisableMessages>
 <Active></Active>
 <Skype i:nil="true"/>
 <PhoneWork></PhoneWork>
 <PhoneMobile i:nil="true"/>
 <LastLogin/>
 <LoginKey></LoginKey>
 <IsCustomUsername></IsCustomUsername>
 <TimeZone></TimeZone>
 <SalesforceId i:nil="true"/>
 <OriginalId></OriginalId>
 <Street1></Street1>
 <Street2 i:nil="true"/>
 <City></City>
 <State></State>
 <PostalCode></PostalCode>
 <Country></Country>
 <CompanyName i:nil="true"/>
 <JobTitle></JobTitle>
 <CustomField1 i:nil="true"/>
 <CustomField2 i:nil="true"/>
 <CustomField3 i:nil="true"/>
 <Culture></Culture>
 <CustomField4 i:nil="true"/>
 <CustomField5 i:nil="true"/>
 <CustomField6 i:nil="true"/>
 <CustomField7 i:nil="true"/>
 <CustomField8 i:nil="true"/>
 <CustomField9 i:nil="true"/>
 <CustomField10 i:nil="true"/>
 <SalesforceContactId i:nil="true"/>
 <SalesforceAccountId i:nil="true"/>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 <UpdatedBy></UpdatedBy>
 <Brand></Brand>
 <ManagerId></ManagerId>
 <ManagerName/>
 <EnableTextNotification></EnableTextNotification>
 <Website/>
 <Twitter/>
 <ExpirationDate/>
 </User>
 <User>
 ..........
 </User>
</Users>

Get Results

Returns a list of all user course results that have changed during the specified interval. You can GET 1000 results using the “limit” parameter.

Request Uri

GET /org/results/details?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<UserResults>
 <UserResult>
 <UserId></UserId>
 <Id></Id>
 <OriginalUserId></OriginalUserId>
 <OriginalCourseId></OriginalCourseId>
 <Active></Active>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <StartedDate></StartedDate>
 <Completed>true/false</Completed>
 <PercentageComplete></PercentageComplete>
 <CompletedDate></CompletedDate>
 <UpToDate>true/false</UpToDate>
 <Overdue>true/false</Overdue>
 <CompliantTillDate i:nil="true"/>
 </UserResult>
 <UserResult>
 ..........
 </UserResult>
</UserResults>

Get Achievements

Returns a list of all users that have earned achievements within a given date range.

Request Uri

GET /org/achievements?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<Achievements>
 <Achievement>
 <UserId></UserId>
 <Id></Id>
 <OriginalUserId></OriginalUserId>
 <OriginalAchievementId></OriginalAchievementId>
 <Title></Title>
 <Description/>
 <AchievementDate></AchievementDate>
 <CourseId></CourseId>
 <OriginalCourseId></OriginalCourseId>
 <CompliantTillDate i:nil="true"/>
 <Score/>
 <Result></Result>
 <Type></Type>
 <CertificateId></CertificateId>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 <UpdatedBy></UpdatedBy>
 </Achievement>
 <Achievement>
 ..........
 </Achievement>
</Achievements>

Get Courses

Returns all the courses in your organization that were created or updated within a given date range.

Request Uri

GET /org/courses?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<Courses>
 <Course>
 <Id></Id>
 <Code/>
 <Name></Name>
 <Active></Active>
 <ForSale></ForSale>
 <OriginalCourseId></OriginalCourseId>
 <Description></Description>
 <EcommerceShortDescription></EcommerceShortDescription>
 <EcommerceLongDescription></EcommerceLongDescription>
 <CourseCodeForBulkImport></CourseCodeForBulkImport>
 <Price></Price>
 <AccessTillDate i:nil="true"/>
 <AccessTillDays i:nil="true"/>
 <CourseTeamLibrary>true/false</CourseTeamLibrary>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 <UpdatedBy></UpdatedBy>
 </Course>
 <Course>
 ..........
 </Course>
</Courses>

Get Learning Paths

Returns all team learning paths that were created/updated within a given date range.

Request Uri

GET /org/learningpaths?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<LearningPaths>
 <LearningPath>
 <Id></Id>
 <Name></Name>
 <Description></Description>
 <Active></Active>
 <OriginalId></OriginalId>
 <ForSale>true/false</ForSale>
 <Price></Price>
 <EcommerceShortDescription/>
 <EcommerceLongDescription/>
 <AccessTillDate i:nil="true"/>
 <AccessTillDays i:nil="true"/>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 </LearningPath>
 <LearningPath>
 ..........
 </LearningPath>
</LearningPaths>

Get Courses and Modules

Returns all modules under each course within a given date range.

Request Uri

GET /org/courses/modules??apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<CourseModules>
 <CourseModule>
  <CourseId></CourseId>
  <Id></Id>
  <OriginalCourseId></OriginalCourseId>
  <OriginalModuleId></OriginalModuleId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </CourseModule>
 <CourseModule>
 ..........
 </CourseModule>
</CourseModules>

Get Courses and Learning Paths

Returns all courses that are assigned to a specific learning path within a given date range.

Request Uri

GET /org/learningpaths/courses?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<LearningPathCourses>
 <LearningPathCourse>
  <LearningPathId></LearningPathId>
  <Id></Id>
  <OriginalLearningPathId></OriginalLearningPathId>
  <OriginalCourseId></OriginalCourseId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </LearningPathCourse>
 <LearningPathCourse>
  ..........
 </LearningPathCourse>
</LearningPathCourses>

Get User Course Assignments

Returns all courses assigned to users within a given date range.

Request Uri

GET /users/courses?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<UserCourses>
 <UserCourse>
  <UserId></UserId>
  <ID></ID>
  <OriginalUserId></OriginalUserId>
  <OriginalCourseId></OriginalCourseId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </UserCourse>
 <UserCourse>
 ..........
 </UserCourse>
</UserCourses>

Get User Learning Path Assignments

Returns all learning-paths assigned to users within a given date range.

Request Uri

GET /org/learningpaths/users?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<LearningPathUsers>
 <LearningPathUser>
  <LearningPathId></LearningPathId>
  <Id></Id>
  <OriginalLearningPathId></OriginalLearningPathId>
  <Active>true/false</Active>
  <OriginalUserId></OriginalUserId>
  <CreatedBy></CreatedBy>
  <CreatedDate></CreatedDate>
  <UpdatedBy></UpdatedBy>
  <UpdatedDate i:nil="true"/>
 </LearningPathUser>
 <LearningPathUser>
 ..........
 </LearningPathUser>
</LearningPathUsers>

Get Teams

Returns all teams that were created or modified within a given date range.

Request Uri

GET /org/teams?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<Teams>
 <Team>
  <Id></Id>
  <Name></Name>
  <OriginalTeamId></OriginalTeamId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
  </Team>
 <Team>
  ..........
 <Team>
</Teams>

Get Team Users Assigned

Returns all user team assignments that were created or modified within a given date range. 

Request Uri

GET /org/teams/users?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<TeamUsers>
 <TeamUser>
  <TeamId></TeamId>
  <Id></Id>
  <OriginalTeamId></OriginalTeamId>
  <OriginalUserId></OriginalUserId>
  <Active>true/false</Active>
  <IsTeamLeader>true/false</IsTeamLeader>
  <IsTeamAdmin>true/false</IsTeamAdmin>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </TeamUser>
 <TeamUser>
 ..........
 </TeamUser>
</TeamUsers>

Get Team and Courses Assigned

Returns all team course assignments that were created or modified within a given date range. 

Request Uri

GET /org/teams/courses?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<TeamCourses>
 <TeamCourse>
  <TeamId></TeamId>
  <Id></Id>
  <OriginalCourseId></OriginalCourseId>
  <OriginalTeamId></OriginalTeamId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </TeamCourse>
 <TeamCourse>
 ..........
 </TeamCourse>
</TeamCourses>

Get Team Learning Paths Assigned

Returns all team learning-paths that were created or modified within a given date range. 

Request Uri

GET /org/teams/learningpaths?apikey={API_KEY}&source=MY_APP&since=[DATE]&to=[DATE]

Response

<TeamLearningPaths>
 <TeamLearningPath>
  <TeamId></TeamId>
  <Id></Id>
  <OriginalLearningPathId></OriginalLearningPathId>
  <OriginalTeamId></OriginalTeamId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate>3</UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </TeamLearningPath>
 <TeamLearningPath>
 ..........
 </TeamLearningPath>
</TeamLearningPaths>

Related articles

Comments

0 comments

Article is closed for comments.