org.hypercerts.claim.measurement

hypercerts.org

Documentation

Measurement data related to a hypercert record (e.g. an activity and its impact).

main record

Measurement data related to a hypercert record (e.g. an activity and its impact).

Record Key tid Timestamp-based ID

Properties

comment string Optional

Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
commentFacets array of ref app.bsky.richtext.facet Optional

Rich text annotations for `comment` (mentions, URLs, hashtags, etc).

createdAt string datetime Required

Client-declared timestamp when this record was originally created

endDate string datetime Optional

The end date and time when the measurement ended. If it was a one time measurement, the endDate should be equal to the startDate.

evidenceURI array of string uri Optional

URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets)

maxLength: 50 items
locations array of ref com.atproto.repo.strongRef Optional

Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon.

maxLength: 100 items
measurers array of ref app.certified.defs#did Optional

DIDs of the entity (or entities) that measured this data

maxLength: 100 items
methodType string Optional

Short identifier for the measurement methodology

maxLength: 30 bytes
methodURI string uri Optional

URI to methodology documentation, standard protocol, or measurement procedure

metric string Required

The metric being measured, e.g. forest area restored, number of users, etc.

maxLength: 500 bytes
startDate string datetime Optional

The start date and time when the measurement began.

subject ref com.atproto.repo.strongRef Optional

A strong reference to the record this measurement refers to (e.g. an activity, project, or claim).

unit string Required

The unit of the measured value (e.g. kg CO₂e, hectares, %, index score).

maxLength: 50 bytes
value string Required

The measured numeric value.

maxLength: 500 bytes
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "metric",
      "unit",
      "value",
      "createdAt"
    ],
    "properties": {
      "unit": {
        "type": "string",
        "maxLength": 50,
        "description": "The unit of the measured value (e.g. kg CO₂e, hectares, %, index score)."
      },
      "value": {
        "type": "string",
        "maxLength": 500,
        "description": "The measured numeric value."
      },
      "metric": {
        "type": "string",
        "maxLength": 500,
        "description": "The metric being measured, e.g. forest area restored, number of users, etc."
      },
      "comment": {
        "type": "string",
        "maxLength": 3000,
        "description": "Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`.",
        "maxGraphemes": 300
      },
      "endDate": {
        "type": "string",
        "format": "datetime",
        "description": "The end date and time when the measurement ended. If it was a one time measurement, the endDate should be equal to the startDate."
      },
      "subject": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "A strong reference to the record this measurement refers to (e.g. an activity, project, or claim)."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this record was originally created"
      },
      "locations": {
        "type": "array",
        "items": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "maxLength": 100,
        "description": "Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon."
      },
      "measurers": {
        "type": "array",
        "items": {
          "ref": "app.certified.defs#did",
          "type": "ref"
        },
        "maxLength": 100,
        "description": "DIDs of the entity (or entities) that measured this data"
      },
      "methodURI": {
        "type": "string",
        "format": "uri",
        "description": "URI to methodology documentation, standard protocol, or measurement procedure"
      },
      "startDate": {
        "type": "string",
        "format": "datetime",
        "description": "The start date and time when the measurement began."
      },
      "methodType": {
        "type": "string",
        "maxLength": 30,
        "description": "Short identifier for the measurement methodology"
      },
      "evidenceURI": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uri"
        },
        "maxLength": 50,
        "description": "URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets)"
      },
      "commentFacets": {
        "type": "array",
        "items": {
          "ref": "app.bsky.richtext.facet",
          "type": "ref"
        },
        "description": "Rich text annotations for `comment` (mentions, URLs, hashtags, etc)."
      }
    }
  },
  "description": "Measurement data related to a hypercert record (e.g. an activity and its impact)."
}

Lexicon Garden

@