`get_flow`

The aggregated flow record

GET https://emporium.ultravioletadao.xyz/api/flow

Where to reach it

REST API	Read-only	`GET https://emporium.ultravioletadao.xyz/api/flow`
MCP	Coming soon
CLI	Coming soon
Python SDK	Coming soon
TypeScript SDK	Coming soon
Rust SDK	Coming soon

Live: you can use it today, to read and to write. Read-only: today you can read, not write. Coming soon: not there yet.

Parameters

Name	In	Required	Schema	What it is
`idioma`	query	no	`string`
`ventana`	query	no	`{"$ref":"#/components/schemas/Ventana"}`

Request body

It takes no body.

Responses

`200`

application/json

{
  "$ref": "#/components/schemas/Rio"
}

Any other status

An error: with JSON, the single envelope, whose error.codigo is one of a closed list

application/json

{
  "$ref": "#/components/schemas/SobreDeError"
}

Schemas

The ones this operation names, as they are in the contract's components.schemas.

CodigoDeError

{
  "enum": [
    "dominio_invalido",
    "slug_ocupado",
    "tenant_no_encontrado",
    "tenant_no_publicado",
    "tenant_suspendido",
    "clave_invalida",
    "estado_no_permite",
    "ventana_no_cumplida",
    "metodo_invalido",
    "manifiesto_invalido",
    "categoria_prohibida",
    "terminos_no_aceptados",
    "canal_no_confirmado",
    "version_de_terminos_desconocida",
    "pedido_invalido",
    "faltan_datos",
    "respuesta_invalida",
    "firma_invalida",
    "enlace_vencido",
    "enlace_ya_usado",
    "demasiadas_peticiones",
    "parametro_invalido",
    "metodo_no_permitido",
    "firma_no_configurada",
    "correo_no_configurado",
    "terminos_no_configurados",
    "casa_no_configurada",
    "almacen_no_disponible",
    "error_interno",
    "paybox_no_configurado",
    "boveda_no_disponible",
    "sesion_requerida",
    "estado_oauth_invalido",
    "consentimiento_rechazado",
    "concesion_insegura",
    "paybox_no_responde",
    "paybox_rechazo",
    "sin_vinculo",
    "vinculo_revocado",
    "vinculo_vencido",
    "reconexion_requerida",
    "vinculo_ajeno",
    "renovacion_en_curso"
  ],
  "type": "string"
}

Columna

{
  "enum": [
    "origen",
    "destino"
  ],
  "type": "string"
}

CuerpoDelError

{
  "additionalProperties": false,
  "properties": {
    "codigo": {
      "$ref": "#/components/schemas/CodigoDeError"
    },
    "detalles": {
      "items": {
        "$ref": "#/components/schemas/Detalle"
      },
      "type": "array"
    },
    "mensaje": {
      "type": "string"
    },
    "peticion_id": {
      "type": "string"
    }
  },
  "required": [
    "codigo",
    "detalles",
    "mensaje",
    "peticion_id"
  ],
  "type": "object"
}

Detalle

{
  "additionalProperties": false,
  "properties": {
    "campo": {
      "type": "string"
    },
    "problema": {
      "type": "string"
    }
  },
  "required": [
    "campo",
    "problema"
  ],
  "type": "object"
}

EnlaceDelRio

{
  "properties": {
    "desde": {
      "type": "string"
    },
    "flujos": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "frase": {
      "type": "string"
    },
    "hasta": {
      "type": "string"
    },
    "motivo": {
      "type": "string"
    },
    "peso": {
      "format": "double",
      "type": "number"
    }
  },
  "required": [
    "desde",
    "flujos",
    "frase",
    "hasta",
    "motivo",
    "peso"
  ],
  "type": "object"
}

HuecoDelRio

{
  "properties": {
    "etiqueta": {
      "type": "string"
    },
    "flujos": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "peso": {
      "format": "double",
      "type": "number"
    },
    "por_que_no_hay": {
      "type": "string"
    },
    "prospecto": {
      "type": "string"
    },
    "que_se_pidio": {
      "type": "string"
    }
  },
  "required": [
    "etiqueta",
    "flujos",
    "peso",
    "por_que_no_hay",
    "prospecto",
    "que_se_pidio"
  ],
  "type": "object"
}

NodoDelRio

{
  "properties": {
    "color": {
      "type": "string"
    },
    "columna": {
      "$ref": "#/components/schemas/Columna"
    },
    "etiqueta": {
      "type": "string"
    },
    "explicacion": {
      "type": "string"
    },
    "flujos": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "type": "string"
    },
    "peso": {
      "format": "double",
      "type": "number"
    },
    "tipo": {
      "type": "string"
    }
  },
  "required": [
    "color",
    "columna",
    "etiqueta",
    "explicacion",
    "flujos",
    "id",
    "peso",
    "tipo"
  ],
  "type": "object"
}

Rio

{
  "properties": {
    "asientos_perdidos": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "aviso": {
      "type": "string"
    },
    "desde": {
      "type": "string"
    },
    "enlaces": {
      "items": {
        "$ref": "#/components/schemas/EnlaceDelRio"
      },
      "type": "array"
    },
    "esquema": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "generado_el": {
      "type": "string"
    },
    "hasta": {
      "type": "string"
    },
    "huecos": {
      "items": {
        "$ref": "#/components/schemas/HuecoDelRio"
      },
      "type": "array"
    },
    "nodos": {
      "items": {
        "$ref": "#/components/schemas/NodoDelRio"
      },
      "type": "array"
    },
    "politicas": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "total_asientos": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "total_flujos": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "ventana": {
      "type": "string"
    }
  },
  "required": [
    "asientos_perdidos",
    "aviso",
    "desde",
    "enlaces",
    "esquema",
    "generado_el",
    "hasta",
    "huecos",
    "nodos",
    "politicas",
    "total_asientos",
    "total_flujos",
    "ventana"
  ],
  "type": "object"
}

SobreDeError

{
  "additionalProperties": false,
  "properties": {
    "error": {
      "$ref": "#/components/schemas/CuerpoDelError"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Ventana

{
  "enum": [
    "1h",
    "24h",
    "7d",
    "30d"
  ],
  "type": "string"
}