Developers — IMPACTER Pathway

Overview

What the API Provides

IMPACTER's measurement platform generates rich data on student voice, language use, skill development, and learning activity. The Partner API surfaces that data to approved systems: SIS platforms, LMS integrations, research teams, and district intelligence tools.

📊

Dashboard Analytics

Tenant-scoped widgets, leaderboards, school/class/student performance metrics, and activity insights; the same data that powers the IMPACTER dashboard.

🎙️

Student Response Data

Comprehensive access to student response records, attribute scores, and voice analytics. Filterable and exportable at scale.

🧠

Scoring Pipeline Access

Review automated ML-generated scores and submit human overrides, enabling human-in-the-loop validation workflows for district validators and researchers.

🔒

Scoped Credentials

Every partner receives a credential set scoped to approved endpoints only. Access is reviewed, documented, and rotatable at any time by the IMPACTER team.

Authentication

How Auth Works

All API requests require two headers identifying your client. Credentials are issued per partner and scoped to the endpoints your integration is approved to access.

01

Issued Credentials

IMPACTER issues you an X-Client-Id and X-Client-Secret after partner review

02

Pass with Every Request

Include both headers on each API call; no sessions, no OAuth flows

03

Scope Enforced

Requests to endpoints outside your approved scope return 403 Forbidden

04

Rotate Anytime

Credentials can be rotated on request via the IMPACTER support team

# Every request must include both headers

GET /api/v2/dashboard/impacterOverviewInsights
X-Client-Id:     your_client_id
X-Client-Secret: your_client_secret
Content-Type:    application/json

# Credentials are tenant-scoped — your data only
# All traffic over HTTPS. HTTP requests are rejected.

Data isolation: Credentials are scoped to a single tenant. Partner A cannot access Partner B's student data regardless of which endpoints are queried.

Versioning

V1 and V2 APIs

Two API generations are available. Both are active and supported. Partners are encouraged to build against V2 for new integrations; V1 remains available for existing implementations.

V1 API

Dashboard widgets, student/class/school metrics, manage scoring, student response report. Straightforward per-widget endpoints. Good for focused integrations.

V2 API

Advanced analytics, leaderboards, attribute scoring, survey data, active learners, and full export endpoints. Recommended for comprehensive data integrations.

API Reference

Available Endpoints

The API is organized into five modules. Click any module to see its full endpoint list. Partners receive access to approved modules only; not all endpoints are available to all integrations.

System Health System health and liveness checks ▼

Lightweight liveness endpoint for monitoring integrations. Returns system status and uptime confirmation.

GET /api/v1/health/status Health check

V1 Insights & Analytics V1 Dashboard widgets, statistics, and per-entity metrics ▼

Read-only access to partner dashboard widgets, statistics, and entity-level metrics. Returns the same data that powers school, class, teacher, and student dashboard views in the IMPACTER platform.

GET/api/v1/dashboard/overviewCached Overview Dashboard Page

GET/api/v1/dashboard/schoolCached School Dashboard Page

GET/api/v1/dashboard/classCached Class Dashboard Page

GET/api/v1/dashboard/teacherCached Teacher Dashboard Page

GET/api/v1/dashboard/studentCached Student Dashboard Page

GET/api/v1/dashboard/titleDashboard Overview Title

GET/api/v1/dashboard/widget/student/avg-word-spokenStudent Average Words Spoken

GET/api/v1/dashboard/widget/student/rank/weekStudent of the Week Ranking

GET/api/v1/dashboard/widget/class-of-weekClass of the Week

GET/api/v1/dashboard/widget/school-of-weekSchool of the Week

GET/api/v1/dashboard/widget/student/list/average-word-writtenList Average Words Written by Students

GET/api/v1/dashboard/widget/student/list/total-activitiesList Total Activities by Students

GET/api/v1/dashboard/widget/student/list/average-word-spokenList Average Words Spoken by Students

GET/api/v1/dashboard/widget/students/impacter-potential/score/course/averageStudent Impacter Potential Course Average

GET/api/v1/dashboard/widget/impacter-potential/studentImpacter Potential per Student

GET/api/v1/dashboard/widget/submissions/daysSubmissions Over Given Days

GET/api/v1/dashboard/widget/impacter-comparison/studentImpacter Comparison Average

GET/api/v1/dashboard/widget/student/total-activities-countStudent Total Activities Count

GET/api/v1/dashboard/widget/teacher/detailsTeacher Target Details

GET/api/v1/dashboard/widget/school/detailsSchool Target Details

GET/api/v1/dashboard/widget/class/detailsClass Target Details

GET/api/v1/dashboard/widget/class/sessionClass Session Stats

GET/api/v1/dashboard/widget/student/detailsStudent Target Details

GET/api/v1/dashboard/login-metricsLogin Metrics Logs

GET/api/v1/dashboard/login-metrics-by-accountLogin Metrics per Account

V2 Insights & Analytics V2 Advanced analytics, leaderboards, exports, and survey data ▼

Advanced read-only access to leaderboards, attribute scoring, activity comparisons, survey analytics, and bulk export endpoints. Recommended for new integrations requiring comprehensive data access.

GET/api/v2/dashboard/impacterOverviewInsightsImpacter Overview Insights

GET/api/v2/dashboard/impacterOverviewSchoolInsightsSchool Insights

GET/api/v2/dashboard/impacterPotentialScoreImpacter Potential Score Distribution

GET/api/v2/dashboard/courseCompletionCourse Completion Distribution

GET/api/v2/dashboard/impacterAttributeScoreRangeImpacter Attribute Score Range

GET/api/v2/dashboard/impacterAverageAttributeScoreAverage Attribute Score

GET/api/v2/dashboard/impacterAttributeScoreSchoolClassAttribute Score By School or Class

GET/api/v2/dashboard/imapcterLeaderboardSchoolSchool Leaderboard

GET/api/v2/dashboard/imapcterLeaderboardTeacherTeacher Leaderboard

GET/api/v2/dashboard/imapcterLeaderboardStudentStudent Leaderboard

GET/api/v2/dashboard/studentsByAttributeStudents By Attribute

GET/api/v2/dashboard/studentDetailsStudents Matching Attribute Value

GET/api/v2/dashboard/attributeScoreByStudentsAttribute Score By Students

GET/api/v2/dashboard/detailsImpacter Detail Records

GET/api/v2/dashboard/impacterActivityComparisonActivity Comparison

GET/api/v2/dashboard/pageFiltersDashboard Page Filters

GET/api/v2/dashboard/numberOfSubmissionsNumber of Submissions By Day

GET/api/v2/dashboard/numberOfSubmissionsByStudentSubmissions By Student

GET/api/v2/dashboard/studentResponsesStudent Responses

GET/api/v2/dashboard/activeLearnersActive Learners

GET/api/v2/dashboard/activityLogHighlightsActivity Log Highlights

GET/api/v2/dashboard/activityLogEventsActivity Log Events

GET/api/v2/dashboard/surveycomparisonSurvey Comparison

GET/api/v2/dashboard/surveyCompletionSurvey Completion

GET/api/v2/dashboard/impacterSchoolListSchool List

GET/api/v2/dashboard/impacterClassListClass List

GET/api/v2/dashboard/impacterAverageCourseCompletionAverage Course Completion

GET/api/v2/dashboard/exportImpacterPotentialScoreExport: Impacter Potential Score

GET/api/v2/dashboard/exportCourseCompletionExport: Course Completion

GET/api/v2/dashboard/exportImpacterAttributeScoreRangeExport: Attribute Score Range

GET/api/v2/dashboard/exportImpacterAverageAttributeScoreExport: Average Attribute Score

GET/api/v2/dashboard/exportImpacterAttributeScoreSchoolClassExport: Attribute Score School or Class

GET/api/v2/dashboard/exportNumberOfSubmissionsExport: Number of Submissions

GET/api/v2/dashboard/exportActiveLearnersExport: Active Learners

GET/api/v2/dashboard/exportSurveyCompletionExport: Survey Completion

Read + Write Manage Scoring Human-in-the-loop ML score validation and override ▼

Retrieve student responses with automated ML scores and submit human-validated overrides. Supports bulk upload via CSV. Designed for district validators, researchers, and calibration workflows that require human review of machine-generated scores.

GET/api/v1/manage-scoring/listGet Manage Scoring Records

GET/api/v1/manage-scoring/filtersGet Filters By Timeframe

GET/api/v1/manage-scoring/exportExport Manage Scoring

POST/api/v1/manage-scoring/update-human-scoreUpdate Human Score

POST/api/v1/manage-scoring/upload-csvBulk Upload Scoring Overrides via CSV

Read Student Response Report Filtered access to student response records and attribute scores ▼

Access comprehensive lists of student responses with associated attribute scores. Supports filtering by timeframe, school, class, and student. Full export available for offline analysis and compliance reporting.

GET/api/v1/student-response-report/listStudent Response Report

GET/api/v1/student-response-report/filtersResponse Report Filters

GET/api/v1/student-response-report/exportExport Student Response Report

Admin endpoints not listed here. The API includes internal admin endpoints for tenant provisioning and credential management. These are reserved for IMPACTER platform operations and are not part of any partner scope.

Partner Access

How to Get Access

API access is not self-serve. We review each integration request to ensure data handling practices, use cases, and technical implementations align with our data governance commitments to partner districts.

1

Submit an Access Request

Email us a brief description of your integration: what system you're building, what data you need, and how it will be used. No formal proposal required at this stage.

Send to: support@impacterpathway.com
Subject: "API Access Request — [Your Org]"
Include: organization name, integration type, modules needed, intended use

2

Technical and Compliance Review

The IMPACTER team reviews your use case against our data governance requirements. We'll align on which endpoints you need, confirm data handling expectations, and document the integration scope.

Typical review time: 3–5 business days
We may request a short technical call for complex integrations

3

Scoped Credentials Issued

Once approved, you receive an X-Client-Id and X-Client-Secret scoped to your approved endpoint set. Access to endpoints outside your scope returns 403 — no broad keys are issued.

Credentials delivered securely out-of-band
Rotation available at any time on request
Access can be expanded later with a supplemental review

Credential Scopes

Common Partner Configurations

Credentials are scoped at the endpoint level. Below are common integration profiles — most partners are configured to one of these, or a subset.

SIS / LMS Integration

Read access to student metrics, class performance, and activity counts. Suitable for syncing IMPACTER data into existing student information systems.

V1 Dashboard · Student Response Report

Research & Analytics Partner

Full read access to V2 analytics and export endpoints. Designed for institutional research teams doing longitudinal or cross-cohort analysis.

V2 Dashboard · Export Endpoints

District Validator

Read + write access to the scoring pipeline. Enables district-side human review and override of ML-generated scores at scale.

Manage Scoring · Student Response Report

Full Platform Integration

Comprehensive access across V1, V2, and scoring modules. For deep integrations requiring the full IMPACTER data surface in an external platform.

All approved modules