Pulse

Run now and return the digest

Runs the checks synchronously and returns the digest. The first run is a baseline: it records what is on file today and reports changes from the next run on. checks narrows the run; format=html|pdf renders it.

post/api/v1/pulse/{sub_id}/run

Request

  • Base URL: https://data.useplinth.com
  • URL: https://data.useplinth.com/api/v1/pulse/{sub_id}/run
  • Auth: API key in header X-API-Key

Path parameters

sub_idstring required

Query parameters

checksstring nullable

Narrow the run to these checks, comma-separated: compliance, filings, grants, gov, people, web. Omit for the subscription's full set.

format'json' | 'xml' nullable
Example:json

json (default) or xml.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.