API Reference

/signalsearch

Version 1.0.0

Servers

  • https://signalsearch-1088100045826.us-east4.run.app

Endpoints

GET /Api

Summary: Retrieve signal records with optional filters

Description: Returns a JSON array of matching signal records (or PDFs when downloadPDF=true). Requires the authKey query parameter and supports optional filters: signalId, documentType, signalscore, and mostrecent.

Security

  • ApiKeyAuth (query parameter authKey)

Sample

https://signalsearch-1088100045826.us-east4.run.app/Api?authKey=YOUR_API_KEY&signalId=100,200&documentType=BoardDocument&signalscore=3,4,5&mostrecent=Historical&downloadPDF=true

Parameters

Name In Required Description Type / Default
authKey query true Your API authentication key string / "a1b2c3d4e5"
signalId query false One or more signal IDs to fetch. array<integer> / [100,200]
documentType query false Category of document to return. BoardDocument or StrategicPlan. string / "BoardDocument"
signalscore query false Filter by one or more signal-score values. array<integer> / [1,2,3,4,5]
mostrecent query false Historical returns only historical versions; MostRecent returns only the most recent version; if omitted, both are returned string / "Historical"
downloadPDF query false If present and set to true, the endpoint will return the corresponding PDF files instead of JSON. Omit to receive JSON.[For premium subscriptions only] boolean
singledownload query false If present and set to yes, the API will convert the Document Link fields into direct API download calls, allowing retrieval of the PDF files directly. If omitted, no conversion occurs and the response remains unchanged. [For premium subscriptions only] boolean

Responses

  • 200: Successful response

Response Fields

Field Type Description
Domo_ID integer Internal system ID
Record ID string Unique identifier for the record
NCES integer School District Identification number from the National Center for Education Statistics (NCES)
Signal ID integer ID for the signal
Signal Name string Name of the signal
Date Posted string (YYYY-MM-DD) Date when the signal was added to the signals dataset
Data string Intent scale score of the signal: "1-Tangential Mention", "2-Preliminary Consideration", "3-Active Evaluation", "4-Implementation in Progress", "5-Completed Implementation", "Affirmative signal"
Decision Log string Summary or reasoning captured for the decision
Chunk Text string Full document text related to the signal
Document Link string (URL) Link to the source document
Document Type string Either "Board Document" (School Board Meeting Minutes) or "Strategic Plan"
Document Date string (YYYY-MM-DD) Date the document was published
Start Year integer or null Start year related to the record (Strategic Plan Only)
End Year integer or null End year related to the record (Strategic Plan Only)
Most Recent string Status of the record: “Historical” indicates rows from past months; “Most Recent” indicates rows from the current cycle.