GxPlex

Glossary

The record terms GXP-OBS defines, keyed by the group each one belongs to, with each definition in the words GXP-OBS publishes. Nothing on this page is defined here.

73 fields in 5 groups, across 2 versions of GXP-OBS, carry 71 distinct names. Of those names, 2 — content_hash and instrument_id — carry a different definition in each group that holds them, and each is addressed by its group. The schema published for /api/v1/instruments.json declares 32 properties for each item, and GXP-OBS defines none of them.

Each term below is addressed by its group and its name, and the overlay marked “?” beside a term on other pages opens the same three statements and links here. The statements are the ones /gxp-obs renders, from the same source.

Every name

In alphabetical order. A name held by more than one group is listed once, with every group that holds it.

The document observation

GXP-OBS version 1. One retrieval of one address on one day. Keyed by instrument_id.

instrument_id string

What it records The id this series was recorded under — a directory name in this archive's observation store.

What it does not claim It does not assert that the subject is a regulatory instrument, and it does not assert that a published page exists for it. This archive also observes listing pages, feed endpoints and redirects, and their series carry ids of the same shape.

Absent or null means Absent on the source-query family, where `source_id` names the subject instead. The two families are disjoint and both are carried in one file.

source_id string

What it records The id of a queried source, on records that describe a query against a publisher API rather than a retrieval of one document.

What it does not claim A source-query record is not an observation of a document. It records what a query returned, and nothing in it is evidence about any one document's text.

Absent or null means Absent on the document-observation family, which carries `instrument_id` instead.

observed_date string | null

What it records The day this archive observed the address.

What it does not claim It is not a publication date, not an effective date, not a date the document changed, and not a date the publisher did anything. It is the day a fetch was made from here.

Absent or null means Never absent on a published observation record: a record with no day is not an observation and is not served.

observed_at string | null

What it records The observation instant, projected to the day at the publication boundary.

What it does not claim It carries no time of day. The stored record keeps its instant; retention is not publication, and an intra-day figure would invite a reader to order events this record cannot order.

Absent or null means Absent where the store holds no instant for the record.

sequence integer

What it records The nth observation of this subject on this day, counted in the order the store recorded them.

What it does not claim A repeated (subject, day) pair is not duplication. This store is append-only with designed same-day revalidation, and `sequence` is what disambiguates several fetches in one day. A repeated (subject, day, digest) triple is a revalidation; only DIFFERING digests on one day are a fork.

Absent or null means Never absent. A record with no sequence could not be addressed.

url string

What it records The address the fetch was aimed at.

What it does not claim It is testimony about where the request went, not a statement about what answered. Where `final_url` differs, that value is the record's address and this one is the question that was asked.

Absent or null means Absent on some source-query records, which name their subject by `source_id` and their request by `query`.

final_url string | null

What it records The address that answered.

What it does not claim A redirect is a publisher's own statement about what supersedes what, and this field reports it. It does not say the two addresses hold the same document, and it does not characterise the relation between them.

Absent or null means Absent where no answering address was recorded. That is a gap in this record, not evidence that the asked address answered.

redirected boolean

What it records Whether the answering address differs from the asked one.

What it does not claim It says nothing about why, and nothing about whether the document at the two addresses is the same document.

Absent or null means Absent where no redirect chain was recorded for the fetch.

http_status integer | null observed: 200, 202, 403, 404, 406, 500, 503, 0

What it records The status code the response carried.

What it does not claim A status code asserts transport success and never artifact identity: 200 does not assert that the response is the document that was asked for. `0` is not a status — it is the browser path, which records no HTTP code, and reading it as a failure would be reading a method as an outcome.

Absent or null means Null where no response was received at all. That is an unmeasured result and not a negative one: it does not report that the document is gone.

fetch_method string observed: direct, browser, api, blocked, failed, no_adapter, unobserved_no_credential

What it records How the fetch was made.

What it does not claim The values are not a ranking and not a quality scale. `blocked` records how a host answered this client on that day; it is a measurement of a transport, not a judgement of a publisher. The list is what the store holds today, not a closed set this record claims for the future.

Absent or null means Absent where no fetch was attempted for the record.

content_hash string | null

What it records SHA-256 of the NORMALISED text of the retrieval, where text was retrieved.

What it does not claim A normalised text is not the document. The digest covers what the normaliser produced from the response, so two equal digests are two equal normalisations and not two identical documents, and two differing digests may differ over something the normaliser kept and a reader would not have noticed. The digest is also not a signature: it proves what these bytes were, never who published them.

Absent or null means Null means nothing was retrieved to hash. It does not mean the document was empty, and it does not mean the document was unchanged. An absent digest is an absent measurement.

previous_hash string | null

What it records The digest this record's digest was compared against.

What it does not claim It names the comparison this record made, not the previous state of the document. Where `series_restarted` is present the comparison crosses a referent change and the two digests are of different things.

Absent or null means Null on the first record of a series, after a restart, and where the previous digest was taken under a different `normalization_profile`, which `comparison_unmeasured` then names. Null is not "no earlier observation exists" — it is "this record compared against nothing".

changed boolean

What it records Whether this record's digest differs from the one it was compared against.

What it does not claim It is a fact about two normalisations of one address. `false` does not assert that the document did not change: a change outside the normalised text, a change and a reversion between two observations, or any change on a day with no observation, is invisible to it. `true` does not assert that the publisher revised anything — a template, a date stamp or a session token in the response can move a digest. Where `previous_hash` is null nothing was compared, and `false` there reports no comparison rather than a document that held still.

Absent or null means Absent where no digest was taken. Absence is not `false`: nothing was compared.

content_length integer

What it records Characters of normalised content.

What it does not claim It measures the normalisation, not the document, and it is not a measure of how much a document says.

Absent or null means Written as 0 wherever no digest was taken. A 0 here is the absence of a measurement and never a measured empty document.

content_type string observed: text/html, application/pdf, application/json,

What it records The media type the response declared.

What it does not claim It is the publisher's own declaration, reported. It was not verified against the bytes, and the empty string is a response that declared none rather than a response that was empty.

Absent or null means Absent where no response was received.

raw_bytes integer | null

What it records Bytes in the response as received.

What it does not claim It is the size of a response on a day, not the size of a document. A refusal page and a document are both responses.

Absent or null means Absent where no response was received.

fetch_duration_ms integer

What it records How long this fetch took, in milliseconds.

What it does not claim It is a fact about one network path on one day, not a property of the publisher and not a measure of a service.

Absent or null means Absent where no fetch completed.

error string | null observed: HTTP 403, HTTP 404, HTTP 500, TimeoutError, URLError, no adapter

What it records The transport error, where one occurred.

What it does not claim An error is an UNMEASURED result and never a negative one. It does not report that the document is gone, that it is unchanged, or that the publisher refused this record specifically — it reports that no measurement was obtained.

Absent or null means Null where the fetch returned without a transport error.

ia_url string | null

What it records A third-party archive copy of this retrieval, where one was made.

What it does not claim It is not this record's copy and this record does not warrant it. A value here says a submission was made and answered, not that the copy still resolves.

Absent or null means Null where no copy was made from here. It is not evidence that no third-party copy exists.

ia_submitted_at string | null

What it records The day the third-party archive submission was made.

What it does not claim It records a submission, not a successful capture.

Absent or null means Absent where no submission was made.

ia_unmeasured object

What it records Why the third-party archive submission produced no measurement, with the cause and the day.

What it does not claim It is the reason a measurement is missing. It is not a failure of the publisher and not a property of the document.

Absent or null means Absent where the submission was measured, either way.

normalised_text_path string | null

What it records Where the normalised text of this retrieval is retained in this archive.

What it does not claim Retention is not publication: the file is not served, and a path here is not an address a consumer can fetch. It is what makes a digest checkable HERE.

Absent or null means Absent where nothing was retained. That is not evidence that the document has no text — restricted documents are observed and hashed and their text is never published.

normalised_from string observed: pdf-text

What it records What the normalised text was extracted from, where extraction was not from the response body directly.

What it does not claim It names the extraction path, not the fidelity of the extraction. Text taken out of a PDF is a reading of a layout.

Absent or null means Absent where the normalisation was taken from the response as received.

series_restarted object

What it records That this record begins a new comparison series, with the cause — the referent this archive hashes for the subject moved.

What it does not claim A restart is a change in what this record MEASURES, never a change in the document. A digest before a restart and a digest after it are digests of different things, and comparing them across the boundary would report a document change that did not happen.

Absent or null means Absent on every record that continues its series.

referent_assertion object

What it records The check that the bytes retrieved are the bytes of the subject this record names — a marker sought in the response, a minimum size, and a verdict.

What it does not claim It confirms that a response is the artifact that was asked for. It does not confirm that the artifact is current, correct or complete, and its absence on a record is not evidence that the referent was wrong.

Absent or null means Absent on records taken before the check existed and on records where no marker is declared for the subject.

rescoped_from string

What it records The address this subject was observed at before a re-scope.

What it does not claim A re-scope is a correction to what this archive tracks. It says nothing about the publisher.

Absent or null means Absent on every record of a subject that was never re-scoped.

rescoped_on string | null

What it records The day the subject was re-scoped.

What it does not claim It is a date in this archive's history, not the publisher's.

Absent or null means Absent on every record of a subject that was never re-scoped.

rescope_reason string

What it records Why the subject was re-scoped, in this archive's own words.

What it does not claim It is this archive's account of its own change. It is a lead and never evidence about the document: evidence is attributable to a voice that is not this one.

Absent or null means Absent on every record of a subject that was never re-scoped.

chrome_excluded array

What it records Named page furniture removed before normalisation, so a banner that changes daily does not read as a document change.

What it does not claim It records what the normaliser dropped. It does not assert that what remains is the document, and a digest is a digest of what survived this list.

Absent or null means Absent where nothing was excluded for the subject.

schema_version integer

What it records The version of the RECORD SHAPE this line was written under.

What it does not claim It is not the version of this specification, and not the version of the API. Three version numbers exist here and they move independently.

Absent or null means Absent on records written before the field existed.

collection_run object

What it records That a collection run outside the nightly sealed this record and that the record entered the store afterwards. `kind` names the run (`attended`), `basis` the identifier of the changelog entry that records the entry, in the `changelog/<file slug>` form /api/v1/events.json gives its ids, `sealed_in` the commit the run sealed the record in, and `compared_against` the commit whose store the run read its earlier records from. No page of this site lists the entry `basis` names: /api/v1/events.json counts it among the changelog entries not on a reader surface. The value identifies a filing; it is not an address a reader can open.

What it does not claim It names how the record reached the store, not what was read: every other field is the run's own. The run read its earlier records from the record at `compared_against`, so every field its collector derives from an earlier record describes that comparison and not the record before this one in the series: `previous_hash`, `changed`, `series_restarted`, `ia_submitted_at`, `ia_url` and `ia_unmeasured` on a document record, and `new_since_last_run` and `new_record_ids` on a source query. The line sits where it was entered, after lines observed later than it was, and `sequence` is counted in that order within its day.

Absent or null means Absent on every record a collection pass wrote into this store as it ran, whether that pass was the nightly or attended. Absence does not mean the record came from the nightly.

The source query

GXP-OBS version 1. One query put to a publisher API on one day. Keyed by source_id, carried in the same file, and not an observation of any document.

query string

What it records The query put to a publisher API.

What it does not claim It records what was asked, not what exists at the publisher.

Absent or null means Absent on the document-observation family.

returned integer

What it records How many records the query returned.

What it does not claim It counts a response. It is not a count of what the publisher holds, and a zero is a zero for THIS query on THAT day.

Absent or null means Absent on the document-observation family.

total_available integer | null

What it records The total the publisher reported for the query.

What it does not claim It is the publisher's own figure, reported. It was not verified here.

Absent or null means Absent where the publisher reported no total.

new_since_last_run integer

What it records How many returned records this archive had not seen before.

What it does not claim New TO THIS ARCHIVE. It is not a count of what the publisher newly issued, and a record can be new here because a query changed.

Absent or null means Absent on the document-observation family.

new_record_ids array

What it records The publisher's identifiers for those records.

What it does not claim The identifiers are the publisher's, carried unaltered.

Absent or null means Absent on the document-observation family.

api_version string

What it records The API version the publisher reported.

What it does not claim Reported, not verified.

Absent or null means Absent where the publisher reported none.

api_last_updated string | null

What it records The last-updated value the publisher reported.

What it does not claim It is the publisher's statement about its own data, reported. It is not an observation of a document.

Absent or null means Absent where the publisher reported none.

licence_class string observed: open, restricted, unknown

What it records What this archive recorded of the terms the queried source states.

What it does not claim It describes this archive's own handling and never what a publisher permits. It is not a licence and not a grant.

Absent or null means Absent where no reading is recorded.

jurisdiction string

What it records The jurisdiction the queried source belongs to.

What it does not claim A fact about the source, not about any document it returned.

Absent or null means Absent on the document-observation family.

sector string observed: cross_sector, pharma, medical_device

What it records The sector the queried source covers, as recorded here.

What it does not claim It describes the SOURCE this archive queried. Nothing here classifies any document by product class, by lifecycle position or by reach: that is a judgement, and this record does not make one.

Absent or null means Absent on the document-observation family.

source_type string observed: api

What it records How the source is read.

What it does not claim It names the access path, not the authority of the source.

Absent or null means Absent on the document-observation family.

content_chars integer

What it records Characters in the normalised response to the query.

What it does not claim It measures a response, not a corpus.

Absent or null means Absent where the response was not normalised.

Diagnostic annotations

GXP-OBS version 1. Present on two records of the published series. They are declared rather than left to a permissive schema because one of them is named in a way a consumer will misread.

status integer observed: 200, 500

What it records An HTTP status code, recorded under this name on two diagnostic records.

What it does not claim It is NOT a document status, a lifecycle position or a verification state. It is a transport code, and this record publishes document statuses on other surfaces with their own acts and dates. Read `http_status` for the transport code of every ordinary record.

Absent or null means Absent on every record except the two that carry a diagnostic note.

finding string observed: http_500, spa_redirects_to_root

What it records A short machine token naming what a diagnostic read established about an address.

What it does not claim It is this archive's own account of a retrieval problem. It is a lead about this archive's reach, never evidence about the document or the publisher.

Absent or null means Absent on every ordinary observation.

note string

What it records The same finding in prose, in this archive's own words.

What it does not claim This archive's own prose is reported class by definition, however accurate. It is a lead and never evidence: what counts as evidence here is attributable to a voice that is not this one.

Absent or null means Absent on every ordinary observation.

method string observed: browser

What it records How the diagnostic read was made, recorded under this name on two records.

What it does not claim It is the same kind of value as `fetch_method` under a second name on two records. Two names for one fact is a defect in the store and it is reported here rather than tidied away, because a spec that hid it would leave a consumer to discover it.

Absent or null means Absent on every ordinary observation.

The signal

GXP-OBS version 2. One entry a publisher listed on a surface this archive reads. It is not an observation of a document and it is not a change.

id string | null

What it records The identifier the collector recorded for this entry.

What it does not claim It is not the publisher's identifier for the document, and two signals carrying one id are not two readings of one document.

Absent or null means The record cannot be addressed, cited or de-duplicated. It is counted apart from the records that can be, and it is not dropped.

source string

What it records The collector whose store this record was appended to.

What it does not claim It names a store in this archive, not the publisher. Two sources may read one publisher and one source may read several.

Absent or null means A record with no source is a record this reader cannot place.

source_url string | null

What it records The address the publisher gave for the entry.

What it does not claim It is not evidence that the address was requested. Read `source_url_provenance` before treating it as a retrieval: an address declared inside a listing and never fetched is the ordinary case.

Absent or null means The listing carried no address for the entry.

source_url_provenance string | null

What it records Whether the address above was answered by a request, or only declared by the publisher inside the listing.

What it does not claim A declared address is a publisher's claim about where something lives. It is not a status code and it is not an identity check.

Absent or null means A store written before the collector recorded the distinction.

published string | null

What it records The day the publisher states for the entry.

What it does not claim It is not the day this archive read it, not the day the entry appeared on the surface, and not a date on which anything took effect.

Absent or null means The publisher stated no date, or stated one this reader could not reduce to a day. Both are an absent day here.

retrieved_at string | null

What it records The day this archive read the surface the entry was on.

What it does not claim It dates the READ, not the entry. An entry read today may have been listed for years, and nothing here says when it appeared.

Absent or null means No retrieval day is recorded, which is an absent measurement rather than an entry that was never read.

title string | null

What it records The publisher's own title for the entry, verbatim, under the word ceiling this record publishes.

What it does not claim A title is what a publisher called something. It is not a description of the document, not a summary and not this record's words.

Absent or null means Either the publisher gave none, or it runs over the ceiling and is WITHHELD WHOLE rather than trimmed — a truncated quote is a misquote. `title_over_quote_cap` says which.

title_over_quote_cap boolean | null

What it records The collector's own verdict, taken at write time from the one home that holds the ceiling.

What it does not claim True does not mean the title is unavailable. It means this record does not publish it, and the entry's own address stands in its place.

Absent or null means A store written before the collector recorded the verdict. A reader may then count the words itself, and says that it did.

content_hash string | null

What it records A digest of the entry as it was read.

What it does not claim It digests the ENTRY as listed, never the document the entry points at. Two equal digests are two identical listings, which is a fact about a listing page.

Absent or null means No digest was taken. It is not an unchanged entry.

kind_all array

What it records Every class value the publisher stated for this entry, verbatim and in the publisher's own document order.

What it does not claim These are the publisher's words, not this record's. Nothing maps them to one another and nothing here says two publishers using one word mean one thing.

Absent or null means Empty is a publisher that stated none. The field being absent is a store written before the collector recorded them, and the two are not the same fact.

signal_class string | null

What it records The class, where the publisher stated one that is in the filed vocabulary and the record's own state agrees with its own value.

What it does not claim It is the publisher's statement carried through, never this record's reading of what an entry is about. No class is inferred from a title, a designator or a numeral.

Absent or null means Read `signal_class_state`. Five readings produce a null here and they are different facts, two of them facts about the RECORD rather than about the publisher.

signal_class_state string

What it records Which reading produced the class: the publisher stated one in the vocabulary, stated one outside it, stated none, the record carries no state at all, or the record's own state and value contradict each other.

What it does not claim `no-class-self-stated` is a publisher that named none on the surface read. It is not a statement that the entry has no class.

Absent or null means A store written before the field existed. Nobody asked, which is not the same as a publisher stating none.

signal_class_basis string | null

What it records The collector's own account of how it reached the verdict.

What it does not claim It is a derivation, not a citation. The evidence is the publisher's own tokens in `kind_all`.

Absent or null means The collector recorded no account.

authority string | null

What it records The host the entry was published on.

What it does not claim A host is not a body and is not a person. No author, editor or contributor element is read into any field here, ever, and a host cannot be one.

Absent or null means No host could be read from the address.

instrument_id string | null

What it records The tracked entry the collector matched this signal to, by the publisher's own stated identifiers.

What it does not claim A match is a fact about identifiers. It is not a claim that the signal is ABOUT the document, and it is not a claim that the document changed.

Absent or null means The signal matched no tracked entry: an official mention with no subject in this corpus. It is not a failed match and it is not a signal about nothing.

attached_source_ids array

What it records Tracked entries named by every address the publisher declared for this entry. A SUPERSET of `instrument_id`, never a replacement for it.

What it does not claim An address naming an entry is not the entry being the subject. A consumer that read the first element as the subject would be choosing one the collector declined to choose.

Absent or null means Empty is a publisher whose declared addresses name no entry this corpus holds. The field being absent is a store written before it existed.

addresses_declared integer | null

What it records How many addresses the publisher declared for the entry.

What it does not claim It counts declarations, not retrievals. None of them was necessarily requested.

Absent or null means The record carries no figure. It is never coalesced to a number.

distance_from_source integer | null

What it records Distance from the source on the filed scale: 0 primary, 1 official notice, 2 official related record, 3 third-party.

What it does not claim It is a position, not a quality. A distance of 3 says a record is third-party; it says nothing about whether it is accurate, and nothing here ranks the four.

Absent or null means NULL IS NOT ZERO, and zero is the strongest claim this scale makes — that the record IS the primary document. A null is an entry that declared no address to measure from, and this store writes no zero at all.

distance_from_source_label string | null

What it records The scale's own word for the value beside it.

What it does not claim The label is the scale's, not the publisher's. Where a record's own label disagrees with the scale, a reader withholds rather than reconciling: neither side adjudicates the other.

Absent or null means No distance was read, so there is no label to carry.

origin string | null

What it records Whether the record came from a publisher over the wire, or from a synthetic fixture authored in this repository.

What it does not claim The writer refuses to append a fixture-sourced record to the live store. This field is a disclosure at the surface and not a second fence: it exists for the day a file is placed in the store by a hand.

Absent or null means The record declares no origin, and NOTHING HERE ASSUMES THE SAFE CASE. A reader states the absence rather than treating it as a wire read.

surface_class string | null

What it records What kind of publisher surface the entry was listed on.

What it does not claim It classes the SURFACE this archive read, not the document and not the entry.

Absent or null means The collector recorded no class for the surface.

The evidence state

GXP-OBS version 2. What this record holds for an entry and by what act — axis two. The objects are the state definitions and the census rows that carry them.

key string

What it records The evidence state's own identifier — one of the eight this record classifies entries into.

What it does not claim The eight are states of THIS RECORD'S HOLDINGS. None of them is a statement about a document, its quality, its standing or its force.

Absent or null means A state with no key is not a state this record can be asked about.

label string

What it records The reader's words for the state.

What it does not claim A label is not a grade. "Verified by a person" is an act this record performed on a day, not a property the document has.

Absent or null means No reader-facing wording is published for the state.

states string

What it records One sentence saying what this record holds when an entry is in this state, and nothing about the document.

What it does not claim It describes a holding. It does not say what a reader should conclude, and it is not a confidence statement.

Absent or null means No sentence is published for the state, which would leave a consumer to infer one — the inference this document exists to remove.

from_the_filed_order boolean

What it records Whether the state is one the filed order names, or one this record added because the order's list did not partition the world.

What it does not claim An added state is not a lesser state. An order's enumerated options are a hypothesis about the world, and a fact rounded onto the nearest listed option is a fact this record would have got wrong.

Absent or null means The provenance of the state is not recorded.

count integer | null

What it records On the axis census: how many entries of the stated population this record classifies into the state.

What it does not claim A count over the corpus is not a per-entry field. This record serves no evidence state on an individual entry through the API today, and a consumer cannot derive one from a census.

Absent or null means The object is a state DEFINITION rather than a census row. A zero on a census row is a measured zero and keeps its place, because a state that emptied and a state nothing was ever classified into wear one number.

Tracked document

The schema published for /api/v1/instruments.json titles each item “Tracked document” and declares 32 properties for it, listed here by name in the schema’s order. GXP-OBS defines none of them, and none is defined here. 8 share a name with a field GXP-OBS defines under one of its groups, named beside each; that field is not this one. 24 share no name with any GXP-OBS field.

Last updated: