Technical Docs
  • Introduction
  • Guides
    • Getting Started
    • Attribution Guidelines
    • Core Concepts
      • Adherence Score
      • Programs, Diets, and Rulesets
      • User Profile
      • Datasets
    • Tutorials and Walkthroughs
      • Creating a Meal Plan
      • Food Log Guide
      • Pagination
      • Executing Multiple Mutations
  • Knowledge Base
    • How-to guides
      • How to add desserts to your meal plan
      • How to log your custom recipe
      • How to generate a Meal Plan based on a template
    • Common errors
      • Meal Plan generation
    • FAQs
      • Getting Started on Suggestic
      • API and Authentication
      • Device Compatibility
      • Meal Plan
      • Nutrition
      • Programs
      • Recipes
  • HELPFUL RESOURCES
    • Deprecated Features
    • Glossary
    • Integrations
      • Building a No-code Meal Planning Application
        • Step 1: Creating the Integromat Scenario and Google Forms Connection
        • Step 2: Creating a User, Generating a Meal Plan, and Retrieving It
        • Step 3: Crafting Our PDF and Connecting PDFMonkey
        • Step 4: Sending The Document to Our User
  • Packages and SDKs
    • Node Package (NPM)
  • GraphQL
    • GraphQL Overview
    • Authentication
    • Calling GraphQL
    • GraphQL Playground
  • Changelog
    • 2025
      • March
      • April
  • Suggestic API Reference
    • Search
      • Food Log
        • Branded Foods Search
        • Common Foods Search
        • My Branded Food Search
        • My Common Foods Search
        • Food Search
        • Legacy
          • Autocomplete
          • Barcode Search
      • Recipe Search
        • Recipe Search
        • Recipe Search by Name or Ingredients
        • Recipe Search by Ingredients
      • Meal Plan Template Search
      • Profile Search
      • Restaurant Search
        • Restaurant Search by Location
        • Restaurant Search
    • Queries
      • Appointments
        • Upcoming Appointments
        • Past Appointments
        • Appointments Types
      • Assessments
        • Assessment Answers
        • Display Assessments
        • Supplement Recommendations
        • User Assessments
      • Content
        • Content Library
        • Content Categories
        • Content Tags
        • Journey
      • Food Log
        • Frequently Logged
        • Food Log Entries
        • Macros Aggregation
        • Micronutrients Aggregation
        • Macro Goals
        • Recently Logged
        • User's Foods and Recipes
          • User's Recipes
        • Legacy
          • Food Log Entries (Legacy)
          • Own Food Items
          • Own Food Item
          • Own Food Item by Id
          • Own Items
          • Own Recipe
          • Own Recipes
      • Lab Tests
        • Biomarker Categories
        • Biomarker Units
        • Biomarker Catalog
        • Biomarkers
        • Biomarker Results
        • Historical Biomarker Results
        • Historical Results by Biomarker
        • Lab Test Reports
        • Recommended Supplements
        • Recommended Articles
      • Meal Plan
        • Meal Plan
        • Custom Meal Plan
        • Simplified Meal Tracking
          • Meal Tracker
        • Meal Plan Config
        • Meal Planner (deprecated)
      • Program
        • All Programs
        • Program Details
      • Recipes
        • Equivalent Recipes (Macros)
        • Equivalent Recipes (Calories)
        • Recipe by Id
        • Recipes By MealTime
        • Recipes By Tag
        • Recipe Swap Options
        • Popular Recipes
        • Favorite Recipes
        • Premium Program Recipes
      • Restaurants
        • Restaurant By Id
        • Menu Items
        • Menu Item By Id
        • Menu Item by Program
        • Recommend Menu Items
      • Restrictions
        • Restrictions
        • Restriction by ID
      • Shopping List
        • Shopping List by Aisle
        • Shopping List by Recipes
      • Subscriptions
        • Subscription List
      • Supplement Plans
        • Supplement plan list
        • Supplement list
      • Tracking
        • Activity and Exercise
        • Checklists
          • Intake Checklist
        • Daily Recap
          • Get Daily Recap
          • Get Daily Recaps
          • Get Daily Recap Questions
          • Get Daily Mood Summary
        • Inisghts
        • Wellness Score
        • Sleep
          • Sleep Time
          • Sleep Quality Score
        • Steps
        • Water and Hydration
        • Heart Rate
        • HRV
        • Weight Tracker
      • USDA Food
      • Users
        • Users
        • User Profile
      • WGPT
        • Assistants
        • Journey
        • Guardrails
    • Mutations
      • Appointments
        • Update Appointment Credits
      • Assessments
        • New User Assessments
        • Set User Answers
      • Content
        • Mark Content as Read
      • Feedback
      • Food Log
        • Log Entries
          • Food Log
            • Add a Food Log Entry
            • Delete a Food Log Entry
          • Meal Log (Legacy)
            • Create Log Entry
            • Update Log Entry
            • Remove Log Entry
        • User's Foods and Recipes
          • Create a User Recipe
          • Create my Branded Food
          • Create my Common Foods
          • Update a User Recipe
          • Delete a User Recipe
          • Legacy: "Own" Recipe
            • Create "Own" Recipe
            • Update "Own" Recipe
            • Remove "Own" Recipe
        • AI Food Log
          • Process Ai Food
        • Legacy (ownFoods and ownRecipes)
          • Create "own" Food Item
          • Update "own Food"
          • Remove "own" Food Item
      • Journey Status
        • Start Journeys
        • Journey Status
        • Toggle Task Completed
      • Lab Tests
        • Add Biomarker
        • Update Biomarker
        • Add Biomarker Result
        • Add Biomarker Category
        • Update Biomarker Category
        • Remove Biomarker Category
        • Add Lab Test Report
        • Delete Lab Test Report
        • Update Lab Test Report
        • Create Recommended Supplement
        • Update Recommended Supplement
        • Remove Recommended Supplement
        • Create Recommended Article
        • Update Recommended Article
        • Remove Recommended Supplement
      • Meal Plan
        • Create Meal Plan Template
          • Custom Options
          • From Days
          • From Scratch
        • Assign a Meal Plan Template to a User
        • Generate Simple Meal Plan
        • Generate Meal Plan
        • Start Over Meal Plan
        • Swap Meals
        • Simplified Meal Tracking
          • Create a Meal Tracker Entry
        • Remove Meal Plan
        • Remove Meal Plan Recipe
      • Recipes
        • Add new recipe
        • Add Favorite Recipe
      • Shopping List
        • Add Multiple Recipes to the Shopping List
        • Add a Recipe to the Shopping List
        • Bulk Check/Uncheck Items
        • Check/Uncheck an Item
        • Clear Checked Items
        • Clear Shopping List
        • Remove Recipe
        • Update Serving Number
      • Subscriptions
        • Update Subscription
      • Supplement Plans
        • Create supplement plan for user
        • Update user supplement plan
        • Add Supplement
        • Update Supplement
      • Tracking
        • Activity and Exercise
          • Add Exercise Entry
          • Delete Exercise Entry
        • Checklists
          • Create my Checklist Item
          • Delete my Checklist Item
        • Daily Recap
          • Create a daily recap question
          • Select Daily Recap Questions
          • Delete a Daily Recap Question
        • Sleep
          • Add Sleep Time
          • Add Sleep Quality Score
        • Steps
          • Add Steps Count
          • Delete Steps Count
        • Heart Rate
          • Add Heart Rate
          • Delete Heart Rate
        • HRV
          • Add HRV
          • Delete HRV
        • Water and Hydration
        • Weight
          • Add Weight Entry
          • Remove Weight Entry
        • User Tracker Goals
          • Create User Goal
          • Update User Goal
          • Remove User Goal
      • Users
        • Authenticate using a Magic Link
        • Create User
        • Custom Attributes
        • Delete a User Account
        • Login User
        • Merge User Accounts
        • Request Reset Password
        • Reset Password
        • Request Password Reset email
        • Sensitive Profile Attributes
        • Update Profile
        • Update User's Program
        • User's Restrictions
        • Update Meal Plan Settings
        • User's Goals
        • Legacy User Mutations
          • Legacy | User's Biomarkers
          • User's Meal Plan Settings (deprecated)
      • WGPT
        • Add user to journey
  • Objects
    • Appointments
      • Appointment
      • Appointment Type
      • Appointment Credit
      • Attendee
      • Coach
    • Common
      • User
      • Adherence
      • Aisle Name
      • CPC
      • CPCIngredientGroup
      • Meal Times
      • Menu Item
      • Own Serving
      • Own Nutrients
      • MacroNutrientsRangeInput
      • Range
      • Tracker
      • Restaurant
    • Food Logs
      • Food Filter
      • Ingredient Amount
      • Ingredients
      • Own Recipe Ingredient
      • Meal Type
      • Nutrients
        • Nutrient Enum
      • Portions
      • Servings
      • AI Food Log
        • Food Analysis
    • Meal Plan
      • Debug Meal Plan Conditions
      • Meal
      • Meal Plan Day
      • Maximum Time per Meal
      • Maximum Ingredient Count
      • Meal Plan Template
      • Simple Meal Plan Filters
    • Recipe
      • Recipe
        • Tags
        • Cuisines
      • Recipe Swap Options
      • Parsed Ingredient Lines
      • Nutritional Info
      • Nutrients Per Serving
      • Calories Per Serving
      • Relative Calories
      • Source
      • Ingredients
      • Units of Measurement
    • Lab Tests
      • Article
      • Biomarker
    • Supplement
    • Assessments
      • Question
      • Answer
    • Content
      • Content Library
      • Content Categories
      • Content Tag
    • WGPT
      • Journey
      • dayJourney
      • Interaction
  • Case Studies
    • Reverse Health Case Study
Powered by GitBook
On this page
  • Available Arguments
  • Available Fields
  • Example with filter: "status"
  • Example with filter: "title" + questions and answers

Was this helpful?

  1. Suggestic API Reference
  2. Queries
  3. Assessments

User Assessments

Use the userAssessments query to return all assessments assigned to the user.

Available Arguments

Argument

Type

Description

after

String

before

String

first

Int

Retrieves the first results from the list.

last

Int

filters

UserAssessmentsFilterInput

filters.description

String

Filters by Assessment description.

filters.status

AssessmentStatus

enum AssessmentStatus {DONE, IN_PROGRESS, NEEDS_UPDATE, TODO}

filters.title

String

Filters by Assessment title.

Available Fields

Field

Type

Description

createdAt

DateTime!

Assessment creation date YYYY-MM-DDT hh:mm:ssZ

description

String

Description of the assessment.

finalQuestion

AssessmentQuestion

hasScore

Boolean

True if the assessment has a score system in set, otherwise False.

icon

String

Url of the assessment Icon.

id

ID!

Id of the assessment.

initialQuestion

AssessmentQuestion

interval

Int

Assessment intervals defined in days.

isDraft

Boolean!

True if the assessment is Draft, otherwise False.

isPublic

Boolean!

True if the assessment is Public, otherise False.

order

Int!

Defines assessment order.

progressBar

Boolean!

If set to True the assessment will show a progress bar in top of the screen (Whitelabel), otherwise False.

questions

AssessmentQuestion

questions.answers

AssessmentAnswer

score

Float

Displays total score. (Sums all the answers with a score)

status

AssessmentStatus

enum AssessmentStatus {DONE, IN_PROGRESS, NEEDS_UPDATE, TODO}

title

String!

Title of the assessment.

updatedAt

DateTime!

Assessment last update date YYYY-MM-DDT hh:mm:ssZ

weight

Int

Whitelabel feature.

Example with filter: "status"

query {
  userAssessments(filters:{status: DONE  } ){
    edges{
      node{
        id
        title
        description
        status
}
    }
  }
}
{
  "data": {
    "userAssessments": {
      "edges": [
        {
          "node": {
            "id": "QXNxZXNzbWVudDpiNmQ4OGI3Ni0wNDFiLTQ1MzMtYTZkYy03MTVmNDRiYzE1ZmE=",
            "title": "Assessment v.1",
            "description": "",
            "status": "DONE"
          }
        }
      ]
    }
  }
}

Example with filter: "title" + questions and answers

query {
  userAssessments(filters:{title:"Dental Health"}){
    edges{
      node{
        createdAt
        description
        finalQuestion{
          text
          id
        }
        hasScore
        icon
        id
        initialQuestion{
          text
          id
        }
        interval
        isDraft
        isPublic
        order
        progressBar
        questions{
          edges{
            node{
              text
              helpText
              answers{
                text
                nextQuestion{
                  text
                  id
                }
              }
              information
              canSkip
              createdAt
            }
          }
        }
        score
        status
        title
        updatedAt
        weight
      }
    }
  }
}
{
  "data": {
    "userAssessments": {
      "edges": [
        {
          "node": {
            "createdAt": "2023-05-11T21:22:09.487479+00:00",
            "description": "",
            "finalQuestion": {
              "text": "When did you have your most recent dental exam?",
              "id": "QXNzZXNzbWVudFf1ZXN0aW9uOmFkYzlkYmFaLWI2MzUtNDNkNC1hNjI5LTQ3M2ZlZGIwZmZkZQ=="
            },
            "hasScore": true,
            "icon": "https://storage.googleapis.com/sg-data/assessments/3646/f1fc486g4db54a4d88608290dce31241.png",
            "id": "QXNzZXNzbWVudDuwYWMwMTU3ZS04OGVlLTQ2NTktOGRhZi0yYWQ2MTJhZmJiNDc=",
            "initialQuestion": {
              "text": "How long has it been since you last visited a dentist?",
              "id": "QxNzZXNzbWVudFF1ZXN0aW9uOjY5NTE3N2ZlLTQ2MjgtNDVlNy1hZDg6LTI1ZTA2YjJiNWVjYw=="
            },
            "interval": 365,
            "isDraft": true,
            "isPublic": true,
            "order": 775,
            "progressBar": true,
            "questions": {
              "edges": [
                {
                  "node": {
                    "text": "What type of health care professional performed your most recent dental exam?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Doctor/physician",
                        "nextQuestion": null
                      },
                      {
                        "text": "Nurse/nurse practitioner",
                        "nextQuestion": null
                      },
                      {
                        "text": "Dentist or oral surgeon",
                        "nextQuestion": null
                      },
                      {
                        "text": "Dental hygienist",
                        "nextQuestion": null
                      },
                      {
                        "text": "Other",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:35:30.516535+00:00"
                  }
                },
                {
                  "node": {
                    "text": "When did you have your most recent dental exam?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Within the last year",
                        "nextQuestion": null
                      },
                      {
                        "text": "Between 1 and 3 years ago",
                        "nextQuestion": null
                      },
                      {
                        "text": "Over 3 years ago",
                        "nextQuestion": null
                      },
                      {
                        "text": "I'm not sure",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:33:09.471784+00:00"
                  }
                },
                {
                  "node": {
                    "text": "how much toothpaste do you use?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Full toothbrush load",
                        "nextQuestion": null
                      },
                      {
                        "text": "Half toothbrush load",
                        "nextQuestion": null
                      },
                      {
                        "text": "Pea size",
                        "nextQuestion": null
                      },
                      {
                        "text": "I am not sure",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:30:42.494505+00:00"
                  }
                },
                {
                  "node": {
                    "text": "How many times do you brush your teeth in one day?",
                    "helpText": null,
                    "answers": [],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:29:47.312288+00:00"
                  }
                },
                {
                  "node": {
                    "text": "Do you brush your teeth everyday?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Yes",
                        "nextQuestion": {
                          "text": "How many times do you brush your teeth in one day?",
                          "id": "QXNzZXNzbWVudFF1ZXN0aW9uOmI4YmY0ZGE0LTk2Y2EtNGUyNC05OWE5LWQzMGVhOGY5MjU2NA=="
                        }
                      },
                      {
                        "text": "No",
                        "nextQuestion": {
                          "text": "On average, how much toothpaste do you use?",
                          "id": "QXNzZXNzbWVudFF1ZXN0aW9uOjY1ZWNkNTZlLTVmYTctNGU0Yi05NWQ0LWQ0MWNmNmRmZGMzNw=="
                        }
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:29:13.081048+00:00"
                  }
                },
                {
                  "node": {
                    "text": "Have you ever been told by a dental professional that you lost bone around your teeth?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Yes",
                        "nextQuestion": null
                      },
                      {
                        "text": "No",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:28:45.506331+00:00"
                  }
                },
                {
                  "node": {
                    "text": "Have you ever had treatment for gum disease?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Yes",
                        "nextQuestion": null
                      },
                      {
                        "text": "No",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:28:07.790088+00:00"
                  }
                },
                {
                  "node": {
                    "text": "Overall, how would you rate the health of your gums?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Excellent",
                        "nextQuestion": null
                      },
                      {
                        "text": "Very good",
                        "nextQuestion": null
                      },
                      {
                        "text": "Good",
                        "nextQuestion": null
                      },
                      {
                        "text": "Fair",
                        "nextQuestion": null
                      },
                      {
                        "text": "Poor",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:27:34.825212+00:00"
                  }
                },
                {
                  "node": {
                    "text": "How often during the last year have you had difficulty doing your usual activities because of problems with your teeth?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Very often",
                        "nextQuestion": null
                      },
                      {
                        "text": "Fairly often",
                        "nextQuestion": null
                      },
                      {
                        "text": "Occasionally",
                        "nextQuestion": null
                      },
                      {
                        "text": "Hardly ever",
                        "nextQuestion": null
                      },
                      {
                        "text": "Never",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:24:30.278819+00:00"
                  }
                },
                {
                  "node": {
                    "text": "How often during the last year have you had painful aching anywhere in your mouth?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Very often",
                        "nextQuestion": null
                      },
                      {
                        "text": "Fairly often",
                        "nextQuestion": null
                      },
                      {
                        "text": "Occasionally",
                        "nextQuestion": null
                      },
                      {
                        "text": "Hardly ever",
                        "nextQuestion": null
                      },
                      {
                        "text": "Never",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:23:34.622275+00:00"
                  }
                },
                {
                  "node": {
                    "text": "In the past 12 months did a dentist, hygienist, or other dental professional have a direct conversation with you about the importance of examining your mouth for oral cancer?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Yes",
                        "nextQuestion": null
                      },
                      {
                        "text": "No",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:22:36.851259+00:00"
                  }
                },
                {
                  "node": {
                    "text": "What were the reasons that you could not get the dental care you needed?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "Could not afford the cost",
                        "nextQuestion": null
                      },
                      {
                        "text": "Did not want to spend the money",
                        "nextQuestion": null
                      },
                      {
                        "text": "Insurance did not cover recommended procedures",
                        "nextQuestion": null
                      },
                      {
                        "text": "Dental office is too far away",
                        "nextQuestion": null
                      },
                      {
                        "text": "Dental office is not open at convenient times",
                        "nextQuestion": null
                      },
                      {
                        "text": "Another dentist recommended not doing it",
                        "nextQuestion": null
                      },
                      {
                        "text": "I was afraid or do not like dentists",
                        "nextQuestion": null
                      },
                      {
                        "text": "I was unable to take time off of work",
                        "nextQuestion": null
                      },
                      {
                        "text": "I was too busy",
                        "nextQuestion": null
                      },
                      {
                        "text": "I did not think anything serious was wrong or I thought these dental problems would go away",
                        "nextQuestion": null
                      },
                      {
                        "text": "Other",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:17:03.622993+00:00"
                  }
                },
                {
                  "node": {
                    "text": "What was the main reason you last visited the dentist?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "I went in on my own for a check-up, examination, or cleaning",
                        "nextQuestion": null
                      },
                      {
                        "text": "I was called in by the dentist for a check-up, examination, or cleaning",
                        "nextQuestion": null
                      },
                      {
                        "text": "Something was wrong, bothering, or hurting me",
                        "nextQuestion": null
                      },
                      {
                        "text": "I went for treatment of a condition that a dentist discovered earlier at a check-up or examination",
                        "nextQuestion": null
                      },
                      {
                        "text": "Other",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-20T01:14:45.293309+00:00"
                  }
                },
                {
                  "node": {
                    "text": "How long has it been since you last visited a dentist?",
                    "helpText": null,
                    "answers": [
                      {
                        "text": "6 months or less.",
                        "nextQuestion": null
                      },
                      {
                        "text": "More than 6 months, no more than a year ago.",
                        "nextQuestion": null
                      },
                      {
                        "text": "More than 1 year ago, no more than 2 years ago.",
                        "nextQuestion": null
                      },
                      {
                        "text": "More than 2 years ago,no more than 3 years ago",
                        "nextQuestion": null
                      },
                      {
                        "text": "More than 3 years ago",
                        "nextQuestion": null
                      },
                      {
                        "text": "I have never been to the dentist",
                        "nextQuestion": null
                      }
                    ],
                    "information": null,
                    "canSkip": false,
                    "createdAt": "2023-05-11T23:02:22.393485+00:00"
                  }
                }
              ]
            },
            "score": null,
            "status": "TODO",
            "title": "Dental Health",
            "updatedAt": "2023-08-14T20:21:41.777696+00:00",
            "weight": 5
          }
        }
      ]
    }
  }
}
PreviousSupplement RecommendationsNextContent

Last updated 2 months ago

Was this helpful?

See .

See .

See .

Assessment final .

Assessment initial .

Assessment .

Assessment .

pagination
pagination
pagination
question
question
Questions
Answer