1. Read the index
role (target, rival, parent or comparable) and its company, and lists its sources. For each source:
recordsandsignals: one entry a kind, each with itscount, its first and last day (from,to),file, the CSV’s address, androws, the same rows as JSON. Wherefileis null,heldsays why.documents: how many, and the first and last day filed.pages, for the company’s own site: the pages read, with their file.
quotes: two files, what its people said (said) and what others said of it (named).licensed: the figures your team’s own data licences read, by vendor, as JSON.reports: your team’s reports on it, each with its JSON address (rows) and its zip (file).not_held: every source that holds nothing for it, with where it stands and why.download: the address of the zip.
target_folder gives the same index.
2. Fetch each file
Fetch eachfile by its own address, with the key. A file holds one source and one kind. A file longer than one answer holds stops at its row limit, says so in its last row, and gives the cursor for the rest in the X-PodData-Next header: ask again with cursor set to it.
file is null and held says why: read its rows as JSON, a page at a time, and save them as JSON.
3. Or take the zip
index.json, coverage.csv and a README.txt that lists each file with its address, and what it leaves out and why. A file that would take it past its row limit is left out, and the README gives its address. PodData’s own copies of originals aren’t in it: each is read on its own with GET /documents/{id}, under the key’s daily limit.
The diligence skill’s puller fetches the index and every file in one command: see A diligence, start to end.
Each file’s columns
A file is at most 10,000 rows; the zip holds at most 100,000 in all.A source’s records
Then a column for each of the records’ own fields, by its name: a registration’s
npi, a licence’s expires.
A source’s signals
Then a column for each of the signals’ own counts.
A company’s documents
Every cell keeps to the rule of the rest of the API: at most 80 words in a row from a source, and no reviewer’s or poster’s name, since none is held.