Skip to main content

TableRequest

Represents a TableRequest.

dimensions object[]

List of dimensions (e.g., ROWS, COLUMNS, PLANES)

  • Array [
  • idstring

    Identifier of the dimension

    Example: ROWS
    axis object[]

    List of axis in this dimension

  • Array [
  • idinteger

    Identifier of the axis

    Example: 3
    labelstring

    Label of the axis

    Example: Eje:3
    axisTypestring

    Type of the axis

    Example: VARIABLES
    variables object[]

    List of variables in this axis

  • Array [
  • idstring

    Identifier of the Variable

    Example: D1
    labelstring

    Label of the Variable

    Example: HOMBRE
    typestring

    Type Variable

    Example: VAR
    subtypestring

    Subtype Variable

    Example: MULTIPLE
    categories object[]

    List of categories in this Variable

  • Array [
  • idstring

    Id category

    Example: SEXO
    idsstring[]

    Identifiers of the Category

    Example: [D1,D2]
    labelstring

    Human-readable label

    Example: Hombre
    typestring

    Type Category

    Example: VAR
    subtypestring

    Subtype Category

    Example: SINGLE
    selectedboolean

    Whether this Variable is the selected one in its axis. Used to pick the slice in the PLANES dimension. Only one Variable per axis can be marked as selected; sending more than one in the same axis results in a 400 Bad Request.

  • ]
  • filterTglstring

    Variable in format TGL.

    selectedboolean

    Whether this Variable is the selected one in its axis. Used to pick the slice in the PLANES dimension. Only one Variable per axis can be marked as selected; sending more than one in the same axis results in a 400 Bad Request.

  • ]
  • statistics object[]

    List of variables in this axis

  • Array [
  • idstring

    Identifier of the Statistic

    Example: COVER
    labelstring

    Label of the Statistic

    Example: Cobertura
    selectedboolean

    Whether this item is the selected one in its axis. Used to pick the slice in the PLANES dimension. Only one item per axis can be marked as selected; sending more than one in the same axis results in a 400 Bad Request.

  • ]
  • supports object[]
  • Array [
  • idstring

    Identifier of the Carrier

    Example: 145
    labelstring

    Label of the Carrier

    Example: TV
    typestring

    Type Carrier

    Example: FOLDER,SUPPORT
    pathstring

    Path Carrier identified folders

    Example: FOLDER,SUPPORT
    insertionsinteger<int32>[]

    List insertions on carrier

    Example: [0,1,2,1,0]
  • ]
  • mediaItems object[]
  • Array [
  • idstring

    Identifier of the Carrier

    Example: 145
    labelstring

    Label of the Carrier

    Example: TV
    typestring

    Type Carrier

    Example: FOLDER,SUPPORT
    pathstring

    Path Carrier identified folders

    Example: FOLDER,SUPPORT
    insertionsinteger<int32>[]

    List insertions on carrier

    Example: [0,1,2,1,0]
  • ]
  • ]
  • ]
  • tableTypestring

    Table Type.

    extraParams object

    Extra parameter like showBases.

    property name*any

    Extra parameter like showBases.

    target object

    Target

    idstring

    Unique identifier

    Example: A1B2C3D4E5F607182930ABCD12345678
    labelstring

    Human-readable label

    Example: Sample element
    filterTglstring

    Filter in TGL format. May be null when the underlying query is empty or unparseable.

    creationDatestring<date-time>

    ISO-8601 formatted creation date and time including timezone.

    Example: 2025-03-01T16:03:27.592+00:00
    updatedDatestring<date-time>

    ISO-8601 formatted last update date and time including timezone.

    Example: 2025-03-01T16:03:27.592+00:00
    workspaceIdstring

    Workspace id that owns this variable. Populated only by endpoints that perform cross-workspace resolution; null when the caller already has the workspace context.

    Example: A1B2C3D4E5F607182930ABCD12345678
    TableRequest
    {
    "dimensions": [
    {
    "id": "ROWS",
    "axis": [
    {
    "id": "1",
    "label": "Eje:1",
    "axisType": "VARIABLES",
    "variables": [
    {
    "id": "SEX",
    "label": "SEXO",
    "type": "VAR",
    "subtype": "SINGLE",
    "categories": [
    {
    "id": "D1",
    "label": "Hombre",
    "type": "CATEGORY"
    },
    {
    "id": "D2",
    "label": "Mujer",
    "type": "CATEGORY"
    }
    ]
    }
    ]
    }
    ]
    },
    {
    "id": "COLUMNS",
    "axis": [
    {
    "id": "2",
    "label": "Eje:2",
    "axisType": "VARIABLES",
    "variables": [
    {
    "id": "EDA1",
    "label": "EDAD 1",
    "type": "VAR",
    "subtype": "SINGLE",
    "categories": [
    {
    "id": "D1",
    "label": "14 a 19",
    "type": "CATEGORY"
    },
    {
    "id": "D2",
    "label": "20 a 24",
    "type": "CATEGORY"
    },
    {
    "id": "D3",
    "label": "25 a 34",
    "type": "CATEGORY"
    },
    {
    "id": "D4",
    "label": "35 a 44",
    "type": "CATEGORY"
    },
    {
    "id": "D5",
    "label": "45 a 54",
    "type": "CATEGORY"
    },
    {
    "id": "D6",
    "label": "55 a 64",
    "type": "CATEGORY"
    },
    {
    "id": "D8",
    "label": "65 a 74",
    "type": "CATEGORY"
    },
    {
    "id": "D9",
    "label": "75 y más",
    "type": "CATEGORY"
    }
    ]
    }
    ],
    "split": false
    }
    ],
    "hidden": false
    },
    {
    "id": "PLANES",
    "axis": [
    {
    "id": "STATISTICS",
    "label": "Estadísticos",
    "axisType": "STATISTICS",
    "statistics": [
    {
    "id": "wTotal",
    "label": "Individuos Pond.",
    "type": "VARIABLES"
    }
    ]
    },
    {
    "id": "3",
    "label": "Eje:3",
    "axisType": "VARIABLES",
    "variables": [
    {
    "id": "ESTATOM",
    "label": "ESTADO CIVIL",
    "type": "VAR",
    "subtype": "SINGLE",
    "items": [
    {
    "id": "D1",
    "label": "Casado",
    "type": "CATEGORY"
    },
    {
    "id": "D2",
    "label": "Soltero",
    "type": "CATEGORY"
    }
    ]
    }
    ]
    }
    ]
    }
    ],
    "tableType": "string",
    "extraParams": {},
    "target": {
    "id": "221351",
    "label": "target 1"
    }
    }