Skip to main content
GET
/
results
/
new
Returns result information for one or more users based on filters provided.
curl --request GET \
  --url https://api.smartermeasure.com/v3/results/new \
  --header 'Authorization: Basic <encoded-value>'
{
  "NumPages": "1",
  "Page": "1",
  "PageSize": "50",
  "Total": "1",
  "Start": "1",
  "End": "1",
  "FirstPageUri": "/v3/results/new?UserId=10000001&PAGE=1",
  "LastPageUri": "/v3/results/new?UserId=10000001&PAGE=1",
  "PreviousPageUri": "",
  "NextPageUri": "",
  "User": {
    "RowNumber": "1",
    "UserId": "10000001",
    "InternalId": "STU-001",
    "CompletionPercentage": "100",
    "DateTimeTaken": "2022-03-02T17:59:40Z",
    "DateTimeLastUpdated": "2022-03-02T18:02:50Z",
    "DateTimeCompleted": "2022-03-02T18:02:50Z",
    "Account": {
      "Id": "410",
      "Name": "DEMO - Integration School"
    },
    "Assessment": {
      "AdminGroupId": "4625",
      "AdminGroupName": "General Sample",
      "TestTakerGroupID": "54106",
      "TestTakerGroupName": "Proctored"
    },
    "FirstName": "Alice",
    "LastName": "Carter",
    "EmailAddress": "alice.carter@example.com",
    "CompositeScore": "54.86",
    "DemographicData": {
      "Gender": [],
      "AgeRange": [],
      "Ethnicity": [],
      "HowManyCourses": [],
      "RightSchoolForMe": [],
      "FirstGeneration": []
    },
    "AssessmentResults": [
      {
        "Title": "Learning Styles",
        "Code": "LearnStyles",
        "IsComplete": "1",
        "AttemptNumber": "1",
        "Percent": "34.92",
        "PointsPossible": "63",
        "PointsAccumulated": "22",
        "SectionVersionID": "25",
        "Primary": "Verbal",
        "DateTimeCompleted": "2022-03-02T18:02:00Z",
        "ExtendedData": [
          [
            {
              "Code": "verbal",
              "Title": "Verbal",
              "PointsPossible": "9",
              "PointsAccumulated": "5"
            },
            {
              "Code": "visual",
              "Title": "Visual",
              "PointsPossible": "9",
              "PointsAccumulated": "3"
            },
            {
              "Code": "aural",
              "Title": "Aural",
              "PointsPossible": "9",
              "PointsAccumulated": "3"
            },
            {
              "Code": "logical",
              "Title": "Logical",
              "PointsPossible": "9",
              "PointsAccumulated": "3"
            },
            {
              "Code": "physical",
              "Title": "Physical",
              "PointsPossible": "9",
              "PointsAccumulated": "3"
            },
            {
              "Code": "social",
              "Title": "Social",
              "PointsPossible": "9",
              "PointsAccumulated": "2"
            },
            {
              "Code": "solitary",
              "Title": "Solitary",
              "PointsPossible": "9",
              "PointsAccumulated": "3"
            }
          ]
        ]
      },
      {
        "Title": "Life Factors",
        "Code": "LifeFactors",
        "IsComplete": "1",
        "AttemptNumber": "1",
        "Percent": "51",
        "PointsPossible": "100",
        "PointsAccumulated": "51",
        "SectionVersionID": "24",
        "Readiness": "fail",
        "DateTimeCompleted": "2022-03-02T18:01:00Z",
        "ExtendedData": [
          [
            {
              "Code": "place",
              "Title": "Place",
              "PointsPossible": "20",
              "PointsAccumulated": "11"
            },
            {
              "Code": "reason",
              "Title": "Reason",
              "PointsPossible": "20",
              "PointsAccumulated": "4"
            },
            {
              "Code": "resources",
              "Title": "Resources",
              "PointsPossible": "20",
              "PointsAccumulated": "10"
            },
            {
              "Code": "skills",
              "Title": "Skills",
              "PointsPossible": "20",
              "PointsAccumulated": "10"
            },
            {
              "Code": "time",
              "Title": "Time",
              "PointsPossible": "20",
              "PointsAccumulated": "16"
            }
          ]
        ]
      },
      {
        "Title": "Reading Rate & Recall",
        "Code": "Reading",
        "IsComplete": "1",
        "AttemptNumber": "1",
        "Percent": "10",
        "PointsPossible": "10",
        "PointsAccumulated": "1",
        "SectionVersionID": "14",
        "Wpm": "6210",
        "Readiness": "fail",
        "DateTimeCompleted": "2022-03-02T18:02:00Z"
      },
      {
        "Title": "Typing Speed & Accuracy",
        "Code": "Typing",
        "IsComplete": "1",
        "AttemptNumber": "1",
        "Wpm": "0",
        "Accuracy": "0",
        "Readiness": "fail",
        "DateTimeCompleted": "2022-03-02T18:03:00Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication with username and password

Query Parameters

​
UserID
string

This can be a comma sep. list of SmarterMeasure user IDs.

​
InternalID
string

InternalID

​
FirstName
string

FirstName

​
LastName
string

LastName

​
EmailAddress
string

EmailAddress

​
Gender
string

Gender

​
AdminGroupUserName
string

AdminGroupUserName

​
TestingGroupUserName
string

TestingGroupUserName

​
IncludeAccountRequestedData
boolean
default:false

IncludeAccountRequestedData

​
StartDate
string

StartDate - When wanting to filter by date started, this is the start date of the date range.

​
EndDate
string

EndDate - When wanting to filter by date started, this is the end date of the date range.

​
UpdateStartDate
string

UpdateStartDate - When wanting to filter by date updated, this is the start date of the date range.

​
UpdateEndDate
string

UpdateEndDate - When wanting to filter by date updated, this is the end date of the date range.

​
CompletionStartDate
string

CompletionStartDate - When wanting to filter by date completed, this is the start date of the date range.

​
CompletionEndDate
string

CompletionEndDate - When wanting to filter by date completed, this is the end date of the date range.

​
IncompleteOnly
boolean
default:false

IncompleteOnly

​
CompleteOnly
boolean
default:false

CompleteOnly

​
StartRecord
integer
default:1

StartRecord

​
EndRecord
integer
default:50

EndRecord

Response

200 - application/json

A list of user results.

​
NumPages
string

Total number of pages.

​
Page
string

Current page number.

​
PageSize
string

Number of records per page.

​
Total
string

Total number of records.

​
Start
string

Start record index for the current page.

​
End
string

End record index for the current page.

​
FirstPageUri
string

URI for the first page of results.

​
LastPageUri
string

URI for the last page of results.

​
PreviousPageUri
string

URI for the previous page of results. Empty string if on first page.

​
NextPageUri
string

URI for the next page of results. Empty string if on last page.

​
User
object

One or more user result records. Returns an object when there is a single result, or an array when there are multiple results.