Grid API Columns

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Every time you request data from the Grid API, you must specify which columns to include in the results.

Each entity type has its own columns you can choose from. For convenience, many entities share the same columns. For example, Cookies and Tags include columns about the configurations for the audits that found the data and columns that describe the Pages where the Cookies and Tags were found. Think of these columns as SQL JOINs to the other entity types, so you don't have to perform a join explicitly.

The Grid API is self documenting, meaning you can query the API to see the list of available columns for each entity.

To see the list of available columns for each entity do a GET request to the entity's schema endpoint. For example, for the pages entity, you can do a GET request to /v3/reports/grid/pages/schema, which will return a JSON description of each column:

{
  "columns": [
    {
      "columnId": "PAGE_TITLE",
      "type": "string",
      ...
    },
    {
      "columnId": "FINAL_PAGE_URL",
      "type": "string",
      ...
    },
    ...
}

Column Types

Every column has a "type" that tells you what kind of data to expect:

Units

You can assume certain units for certain kinds of number columns:

Entity References

Entity references are a special type of column whose format varies from column to column. The schema endpoint describes what you can expect for entity_reference columns, with the following properties:

Here are some common examples of entity references:

Example: Folders

The FOLDER column is a reference to a folder. The FOLDER columns contains an array of values that tell you know about the folder.

Example FOLDER value: [1234, "My Folder Name"]

The first value is the folder ID, and the second value is the folder name.

The schema endpoint describes the FOLDER column as follows:

{
    "columnId": "FOLDER",
    "type": "entity_reference",
    ... // other properties omitted for brevity

    // The "referenceType" property tells you what kind of entity this is:
    "referenceType": "folder",

    // This entity_reference is not an enum or a list:
    "isEnum": false,
    "isList": false

    // The "fields" property describes each element to expect in the entity reference data,
    // which refer to other column IDs:
    "fields": [
        {
            "fieldName": "id",
            "columnId": "FOLDER_ID"
        },
        {
            "fieldName": "name",
            "columnId": "FOLDER_NAME"
        }
    ]
}

Example: Labels

The LABELS column contains a list of label IDs.

Example LABELS value: [1234, 5678]

Each value is a label ID. You can use the /v2/labels API endpoint to map label IDs to label names.

{
    "columnId": "LABELS",
    "type": "entity_reference",
    ... // other properties omitted for brevity

    // Tells you that the IDs in this field refer to labels:
    "referenceType": "label",

    // This is not an enum value:
    "isEnum": false,

    // This field returns a list of values (rather than a single value) 
    "isList": true

    // This tells you that each element in the list consists of a label ID:
    "fields": [
        {
            "fieldName": "id"
        }
    ],
}