Active Travel Tracker API

• meta object required
  • scope string required
    school council
  • id string required
  • from string (date) required
  • to string (date) required
  • totalRecords integer required — Number of rows in data, not the number of journeys.
  • note string required
• data array of object required
  • date string (date) required
  • school string required
  • className string required
  • yearGroup string required
  • mode string required
    WALK CYCLE SCOOTER PARK_STRIDE BUS RAIL CAR_SHARE CAR
  • count integer required

{
  "meta": {
    "scope": "council",
    "id": "clx0council",
    "from": "2026-09-01",
    "to": "2026-09-30",
    "totalRecords": 1,
    "note": "Data is aggregated by date/school/class/mode. No individual student identifiers are included."
  },
  "data": [
    {
      "date": "2026-09-01",
      "school": "St. Brigid's NS",
      "className": "3rd Class A",
      "yearGroup": "3rd",
      "mode": "WALK",
      "count": 18
    }
  ]
}

• error string required

• error string required

• error string required

• error string required

• totalStudents integer required
• overallActiveRate integer required — Whole-number percentage.
• schoolCount integer required
• yearlyTrend array of object required — One entry per month with any journeys, oldest first.
  • month string required
  • activePct integer required
  • totalJourneys integer required
• primaryVsSecondary object required
  • primary object required
    • schoolCount integer required
    • totalStudents integer required
    • activeRate integer required
  • secondary object required
    • schoolCount integer required
    • totalStudents integer required
    • activeRate integer required
• topMovers array of object required — The five schools with the highest active rate.
  • schoolName string required
  • schoolNameAlt string, nullable required
  • activeRate integer required
  • logsToday integer required — Journeys in the period.
• councilKpis object required
  • totalStudents integer required
  • overallActiveRate integer required
  • schoolCount integer required
  • co2SavedThisYear number required — Kilograms, modelled from journey counts.
  • kmWalkedThisYear number required — Modelled from journey counts.
  • kmCycledThisYear number required — Modelled from journey counts.
  • totalJourneysThisYear integer required
• councilModeMix object required — Journey count per travel mode. Modes with no journeys are absent.
  • <key> integer
• schoolLocations array of object required
  • name string required
  • nameAlt string, nullable required — The Irish-language name.
  • latitude number required
  • longitude number required
  • studentCount integer required
  • activeRate integer required — Whole-number percentage.

• error string required

• error string required

• error string required

• error string required

• error string required

• summary object required
  • totalSchools integer required
  • activeSchools integer required — Schools with a check-in in the period.
  • everSchools integer required — Schools that have ever checked in.
  • newSchoolsAdded integer required — Schools created in the period.
  • newSchoolsStarted integer required — Schools whose first ever check-in was in the period.
  • totalClasses integer required — Classes of the current academic year.
  • activeClasses integer required
  • everClasses integer required
  • newClassesStarted integer required
  • totalStudents integer required
  • totalCheckIns integer required
  • activeDays integer required — Distinct days with any check-in.
  • prev object required — The same measures for the window of equal length immediately before the period.
    • activeSchools integer required
    • activeClasses integer required
    • checkIns integer required
• weekly array of object required — Monday-anchored weeks, zero-filled.
  • weekOf string (date) required
  • checkIns integer required
  • schools integer required — Distinct schools that checked in.
  • classes integer required — Distinct classes that checked in.
• schools array of object required
  • id string required
  • name string required
  • nameAlt string, nullable required
  • type string required
    PRIMARY SECONDARY
  • addedAt string (date) required
  • addedInPeriod boolean required
  • startedInPeriod boolean required
  • stage string required — Where the school is in getting going. active has check-ins in the period; quiet has checked in before but not in the period; notStarted has classes but has never checked in; noClasses has no classes this year. new is reserved and not currently produced.
    new noClasses notStarted quiet active
  • classes integer required
  • activeClasses integer required
  • students integer required
  • checkIns integer required
  • activeDays integer required
  • lastCheckIn string (date), nullable required
• quietClasses array of object required — Every class with no check-ins in the period.
  • id string required
  • schoolId string required
  • schoolName string required
  • schoolNameAlt string, nullable required
  • name string required
  • students integer required
  • lastCheckIn string (date), nullable required

• error string required

• error string required

• error string required

• error string required

• error string required

• schoolSummaries array of object required
  • schoolName string required
  • schoolNameAlt string, nullable required
  • studentCount integer required
  • activeRate integer required
  • rank integer required — 1 is the highest active rate.
  • modeMix object required — Journey count per travel mode. Modes with no journeys are absent.
    • <key> integer
• clusterKpis object required
  • totalStudents integer required
  • checkedInToday integer required — Journeys in the period.
  • overallActiveRate integer required
  • schoolCount integer required
  • co2SavedThisTerm number required — Kilograms, modelled.
• weeklyTrend array of object required — The last 7 days, independent of from/to. Days with no journeys are absent.
  • date string (date) required
  • activePct integer required
• trend array of object required — Monday-anchored weekly buckets across the selected period.
  • weekStart string (date) required
  • activePct integer required
• clusterModeMix object required — Journey count per travel mode. Modes with no journeys are absent.
  • <key> integer
• schoolLocations array of object required
  • name string required
  • nameAlt string, nullable required — The Irish-language name.
  • latitude number required
  • longitude number required
  • studentCount integer required
  • activeRate integer required — Whole-number percentage.

• error string required

• error string required

• error string required

• error string required

• error string required

• schoolName string, nullable required
• schoolNameAlt string, nullable required
• kpis object required
  • checkedIn integer required — Check-ins by active pupils, averaged over the days the school logged anything. Read it against total.
  • total integer required — Active pupils on the roll.
  • activePct integer required
  • co2Saved number required — Kilograms, modelled.
  • kmWalked number required — Modelled.
  • kmCycled number required — Modelled.
• todayMix object required — Mode mix across the selected period (the name is historical).
  • <key> integer
• classSummaries array of object required — Highest active rate first.
  • id string required
  • name string required
  • yearGroup string required
  • studentCount integer required
  • checkedIn integer required
  • activeRate integer required
  • topMode string, nullable required
    WALK CYCLE SCOOTER PARK_STRIDE BUS RAIL CAR_SHARE CAR
  • modeCounts object required — Journey count per travel mode. Modes with no journeys are absent.
    • <key> integer
  • trend array of integer required — Active percentage for each of the last 10 school weekdays, oldest first. 0 where there were no journeys.
• weeklyTrend array of object required — The last 10 school weekdays, oldest first.
  • date string (date) required
  • activePct integer required

• error string required

• error string required

• error string required

• error string required

• error string required

• id string required
• name string required
• yearGroup string required
• studentCount integer required — Active pupils on the roll.

• error string required

• error string required

• error string required

• error string required

• error string required

• id string required
• name string required
• yearGroup string required
• schoolId string required
• school object required
  • name string required
• features object required — The council's resolved feature switches, by feature name.
  • <key> boolean
• branding object required
  • accentColor string, nullable required
  • logoUrl string, nullable required
  • banner object, nullable required — The council's board banner, if it has one.
    • src string required — Path of the banner image.
    • alt string required
  • characters array of string, nullable required — Image paths of the council's check-in characters, if it has them.
• councilSlug string, nullable required — Null unless the council has the privacy-notice feature on and has published a notice.

• error string required

• error string required

• error string required

• error string required

• id string required
• displayName string required
• todayMode string, nullable required
  WALK CYCLE SCOOTER PARK_STRIDE BUS RAIL CAR_SHARE CAR

• error string required

• error string required

• error string required

• error string required

• error string required

• id string required
• displayName string required
• classId string required
• active boolean required — Always true; inactive pupils are not found.
• deactivatedAt string (date-time), nullable
• createdAt string (date-time) required
• class object required — The pupil's class row, with the size of its roll.
  • id string required
  • name string required
  • schoolId string required
  • academicYearId string required
  • yearGroup string required
  • parentCode string, nullable — The class's parent share-link code.
  • createdAt string (date-time) required
  • _count object required
    • students integer — Active pupils on the roll.
• statsToken string, nullable required — Short-lived token scoped to this pupil, for the Pupil statistics endpoints (?statsToken=).

• error string required

• error string required

• error string required

• error string required

• studentId string required
• mode string required
  WALK CYCLE SCOOTER PARK_STRIDE BUS RAIL CAR_SHARE CAR
• time string (date-time) required — When the check-in was recorded.

• error string required

• error string required

• error string required

• error string required

• error string required

• studentId string required
• activeDays integer required — Active journeys logged, all time.
• streak integer required
• activeDaysThisMonth integer required — Active days in the current Dublin calendar month.
• monthlyTarget integer required — Active days needed in a month for the Monthly Hero badge.

• error string required

• error string required

• error string required

• error string required

• error string required

• id string required
• type string required
  FIRST_ACTIVE_DAY STREAK_5 STREAK_10 STREAK_20 CHALLENGE_WINNER MONTHLY_HERO
• awardedAt string (date-time) required

• error string required

• error string required

• error string required

• error string required