← Back to the API

Developer resources

API documentation

Try a sample response and explore the data contract.

Ready to explore

Real fields.
A clear starting point.

Try the same historical record in JSON and XML. No API key, account or setup is needed for the sample files.

01 / Try a response

Start with a sample.

Use a fixed response to test your field bindings, explore the structure and build a first integration.

curl --fail --include 'https://goverlytics.com/api/samples/member.json'
curl --fail --include 'https://goverlytics.com/api/samples/member.xml'

Use the same paths on your integration environment’s origin. Responses use application/json and application/xml. These fixed files do not execute query flags or retrieve current activity.

Sample JSON response

Mike Farnworth

May 2026 · 17 captured contributions

On-air status: Sample
{
  "schema_version": "broadcast-documentation-sample-1.0",
  "label_language": "en",
  "on_air_status": "sample",
  "member_id": "bc-mla-33",
  "name_display": "Mike Farnworth",
  "role_title": "MLA",
  "role_title_long": null,
  "district": "Port Coquitlam",
  "period_start": "2026-05-01",
  "period_end_exclusive": "2026-06-01",
  "retrieved_at": "2026-10-21T22:29:34.708354+00:00",
  "data_as_of": "2026-05-28T07:00:00.000Z",
  "identity_as_of": "2026-10-13",
  "palette_version": "broadcast-sample-palette-1.0",
  "recorded_contributions": 17,
  "topic_matched_contributions": 12,
  "unclassified_contributions": 5,
  "share_denominator": 17,
  "source_credit": "Goverlytics · Parliamentary records",
  "source_urls": [
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260504pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260505am-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260505pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260506pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260507am-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260507pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260519am-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260519pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260520pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260521am-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260521pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260525pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260526am-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260526pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260527pm-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260528am-House-Blues.htm",
    "https://lims.leg.bc.ca/hdms/file/Debates/43rd2nd/20260528pm-House-Blues.htm"
  ],
  "methodology_url": "https://goverlytics.com/api/documentation/#methodology",
  "provenance": {
    "analysis_id": "onair-1c842f2ba6b75d9164fb76651c6a58f44bb86eb8f9157c9ecdc259700e44df2f",
    "source_schema_version": "onair-0.2",
    "taxonomy_version": "product-public-issues-14-social-services-20261022",
    "member_id_scope": "fixed sample roster; not a guaranteed permanent live API identifier",
    "graph_person_id": "714106",
    "identity_source_url": "https://www.leg.bc.ca/members/43rd-Parliament/Farnworth-Mike",
    "raw_summary_url": "/media-pack/samples/goverlytics-bc-broadcast-media-pack-2026-01-to-06/bc-mlas/evidence/bc-mla-33/2026-05/summary.json"
  },
  "qa": {
    "source_status": "ok",
    "review_required": true,
    "review_status": "editorial_review_required",
    "activity_eligible": true,
    "glyph_check_required": false,
    "air_ready": false,
    "historical_identity_verified": false,
    "headshot_redistribution_verified": false
  },
  "topics": [
    {
      "topic_id": "concept-501100",
      "topic_key": "transport",
      "label": "Transportation",
      "count": 5,
      "share_recorded": 29.4,
      "color": "#7C3AED"
    },
    {
      "topic_id": "concept-44948",
      "topic_key": "economy",
      "label": "Economy & Employment",
      "count": 3,
      "share_recorded": 17.6,
      "color": "#D55E00"
    },
    {
      "topic_id": "concept-397184",
      "topic_key": "environment",
      "label": "Environment & Resources",
      "count": 2,
      "share_recorded": 11.8,
      "color": "#117733"
    },
    {
      "topic_id": "concept-501071",
      "topic_key": "governance",
      "label": "Governance",
      "count": 2,
      "share_recorded": 11.8,
      "color": "#0072B2"
    },
    {
      "topic_id": "concept-501083",
      "topic_key": "safety",
      "label": "Public Safety & Justice",
      "count": 2,
      "share_recorded": 11.8,
      "color": "#56B4E9"
    },
    {
      "topic_id": "concept-42437",
      "topic_key": "community",
      "label": "Community Life",
      "count": 1,
      "share_recorded": 5.9,
      "color": "#E69F00"
    },
    {
      "topic_id": "concept-501080",
      "topic_key": "housing",
      "label": "Housing & Development",
      "count": 1,
      "share_recorded": 5.9,
      "color": "#EE8866"
    },
    {
      "topic_id": "concept-501089",
      "topic_key": "science",
      "label": "Science & Technology",
      "count": 1,
      "share_recorded": 5.9,
      "color": "#AA4499"
    }
  ],
  "top_1_topic_id": "concept-501100",
  "top_1_label": "Transportation",
  "top_1_count": 5,
  "top_1_share": 29.4,
  "top_1_color": "#7C3AED",
  "top_2_topic_id": "concept-44948",
  "top_2_label": "Economy & Employment",
  "top_2_count": 3,
  "top_2_share": 17.6,
  "top_2_color": "#D55E00",
  "top_3_topic_id": "concept-397184",
  "top_3_label": "Environment & Resources",
  "top_3_count": 2,
  "top_3_share": 11.8,
  "top_3_color": "#117733",
  "top_4_topic_id": "concept-501071",
  "top_4_label": "Governance",
  "top_4_count": 2,
  "top_4_share": 11.8,
  "top_4_color": "#0072B2",
  "top_5_topic_id": "concept-501083",
  "top_5_label": "Public Safety & Justice",
  "top_5_count": 2,
  "top_5_share": 11.8,
  "top_5_color": "#56B4E9",
  "top_6_topic_id": "concept-42437",
  "top_6_label": "Community Life",
  "top_6_count": 1,
  "top_6_share": 5.9,
  "top_6_color": "#E69F00"
}
02 / Understand the contract

A reference you can build with.

Field definitions

Numeric fields and labels are available as arrays and flat template bindings. This versioned documentation projection groups technical flags in qa and derives graphic slots from topics[]; it does not change the deployed live schema.

JSON fields and XML elements in the documentation sample
FieldMeaning and binding guidance
schema_versionVersion of this documentation sample. The live onair-0.2 contract and original exports remain separate.
label_languageen: captured labels are English. Numeric fields allow templates to format values; verified French labels are not supplied.
on_air_statussample: for integration testing; editorial clearance is still required before broadcast. QA details stay in qa.
member_idA roster identifier within this fixed package, not an array position or a guaranteed permanent live API ID.
provenance.graph_person_idNumeric graph Person ID used by the documented live endpoint; distinct from the sample roster ID.
provenance.analysis_idCapture revision used to match counts to supporting evidence; not a member identifier.
role_title / role_title_longBasic stored role; long title is null because a verified, dated portfolio is not supplied.
period_start / period_end_exclusiveISO dates in UTC. May 1 to June 1 covers May; the end is exclusive.
retrieved_at / data_as_of / identity_as_ofCapture retrieval time, latest observed source record in this sample, and separate roster identity date. None is a live ingestion watermark.
recorded_contributionsAll captured contributions for this member and period, including unclassified records.
topics[]Positive topic counts with captured topic IDs and keys. Topic IDs are scoped to the named taxonomy version. Categories overlap.
share_denominator / top_1_shareAll captured contributions / percentage tagged with the leading category. Here: 5 ÷ 17 × 100 = 29.4%.
top_1_* through top_6_*Flat numeric bindings generated from the same topics array. Only available positive slots are emitted. Templates can localize numbers and labels.
source_urls / methodology_urlStored source references and counting methodology. Source availability has not been independently rechecked.
qaPreserved review, activity, glyph, identity and image-rights flags. An eligible activity count does not establish editorial clearance.

XML uses the broadcast_sample root, repeated topics/topic elements, and flat elements such as top_1_count. Null values use xsi:nil="true". XPression bindings need scene-specific validation; this sample does not claim a tested on-air scene.

Sample provenance and readiness

Historical integration data; editorial clearance required. Existing capture files and legacy bindings are preserved.

Activity window (UTC)
to , exclusive end
Latest observed source record
Capture retrieved
Roster identity captured

Roster source ↗ · Stored Hansard reference ↗

Published sample topic palette assigns Transportation a distinct purple. These are proposed presentation colours; original captures retain their original palette. Party colours are proposed metadata. Brand approval, font coverage and French-language template validation remain separate from numeric field binding. The explorer uses packaged portraits; image redistribution rights are unverified, so the documentation sample supplies no broadcast headshot URL.

Live API contract and date windows

The documented contract includes concepts, design tokens, and member on-air analysis. Requests require an API key. Keep credentials in your server integration. The example covers May 2026: June 1 is the exclusive UTC end.

curl --get 'https://api.goverlytics.com/api/v1/broadcast/legislators/714106/on-air' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --data-urlencode 'period_start=2026-05-01' \
  --data-urlencode 'period_end=2026-06-01'

This is an illustrative request. A working live credential, current coverage and the deployed response schema must be confirmed during onboarding. Optional evidence requests pin the returned analysis ID. The XML sample is a fixed file; a live XML endpoint has not been verified here.

Open API reference ↗

Behind every number

What the data tells you.

01 / Counts

Captured contributions.

Each captured contribution counts once per category, even when several detailed tags match. This measures recorded activity, not speaking time or effectiveness.

02 / Shares

A visible denominator.

Transportation accounts for 5 of 17 captured contributions: 29.4%. Categories overlap, so their shares can sum above 100%.

03 / Coverage

Source context included.

12 contributions have accepted topic matches; 5 are unclassified. Their cause is not inferred. All captured contributions form the share denominator; complete ingestion is not certified.

03 / Plan your integration

Move from sample to service.

Live access, coverage and delivery requirements are confirmed with your team during onboarding.

Sample freshness
Fixed January–June 2026 activity. No current fall sample is supplied; rebuilds do not refresh it.
Update cadence & latency
Confirmed during onboarding; no published latency commitment.
Rate limits
Confirmed during onboarding; no published request quota.
Uptime
Confirmed during onboarding; no published SLA.
Pricing
No published tiers. Discuss your intended integration and coverage requirements.