Listar páginas
Alcance requerido: pages:read.
query Parameters
limitCantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.
pageÍndice de página que empieza en cero. La API devuelve limit registros a partir de page × limit.
project_idSolo registros de este proyecto.
site_idSolo páginas de este sitio.
publishedtrue para publicadas, false para borradores.
is_quiztrue para devolver solo quizzes.
has_elementSolo páginas cuyo constructor contiene este tipo de elemento.
available_for_funneltrue para ocultar páginas que ya están en un embudo.
Listar páginas › Responses
Registros coincidentes. El cuerpo es un arreglo JSON.
idId de la página.
nameNombre visible. Incluye el sitio entre paréntesis cuando la página está en un sitio.
page_nameNombre sin el sufijo del sitio.
statuspublished o draft.
is_quiztrue cuando la página es un quiz.
project_idId del proyecto.
site_idId del sitio cuando la página está unida a un sitio.
site_nameNombre del sitio.
domainDominio publicado.
slugRuta en el sitio. Vacío significa la raíz.
urlURL pública después de publicar.
edit_urlEnlace a la página en el constructor.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
published_atHora de publicación ISO-8601.
Crear una página en blanco
Crea un borrador. Publícalo después con POST /pages/publish.
Alcance requerido: pages:write.
Crear una página en blanco › Responses
La página creada.
idId de la página.
nameNombre visible. Incluye el sitio entre paréntesis cuando la página está en un sitio.
page_nameNombre sin el sufijo del sitio.
statuspublished o draft.
is_quiztrue cuando la página es un quiz.
project_idId del proyecto.
site_idId del sitio cuando la página está unida a un sitio.
site_nameNombre del sitio.
domainDominio publicado.
slugRuta en el sitio. Vacío significa la raíz.
urlURL pública después de publicar.
edit_urlEnlace a la página en el constructor.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
published_atHora de publicación ISO-8601.
Crear una página desde una plantilla
Alcance requerido: pages:write.
Crear una página desde una plantilla › Request Body
template_idId de plantilla de GET /templates.
nameNombre de la página nueva.
site_idSitio al que unirla, si aplica.
project_idId del proyecto.
Crear una página desde una plantilla › Responses
La página clonada.
idId de la página.
nameNombre visible. Incluye el sitio entre paréntesis cuando la página está en un sitio.
page_nameNombre sin el sufijo del sitio.
statuspublished o draft.
is_quiztrue cuando la página es un quiz.
project_idId del proyecto.
site_idId del sitio cuando la página está unida a un sitio.
site_nameNombre del sitio.
domainDominio publicado.
slugRuta en el sitio. Vacío significa la raíz.
urlURL pública después de publicar.
edit_urlEnlace a la página en el constructor.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
published_atHora de publicación ISO-8601.
Duplicar una página
Actualizar metadatos de la página
page_id es obligatorio, más al menos uno de name, project_id, tags o product_label. tags puede ser un arreglo o un texto separado por comas.
Alcance requerido: pages:write.
Actualizar metadatos de la página › Request Body
page_idId de la página.
nameNuevo nombre.
project_idNuevo id de proyecto.
tagsArreglo de etiquetas, o texto separado por comas.
product_labelEtiqueta de producto. produkt se acepta como alias.
Actualizar metadatos de la página › Responses
Los metadatos actualizados.
idId de la página.
page_idId de la página.
updatedtrue cuando se guardó.
nameNombre después de la actualización.
project_idId de proyecto después de la actualización.
tagsEtiquetas después de la actualización.
product_labelEtiqueta después de la actualización.
Actualizar contenido mapeado
updates es un objeto de claves del mapa de contenido. Léelas en GET /search/page-content-map. Las claves desconocidas vuelven en missing y no se aplican.
Alcance requerido: pages:write.
Actualizar contenido mapeado › Request Body
page_idId de la página.
Mapa de claves de contenido a valores nuevos. También se acepta un string JSON.
Actualizar contenido mapeado › Responses
El resultado de la actualización.
idId de la página.
page_idId de la página.
successtrue cuando la solicitud terminó.
applied_countCantidad de campos actualizados.
changed_section_countCantidad de secciones reescritas.
missing_countCantidad de claves no encontradas.
appliedTexto JSON de las actualizaciones aplicadas.
missingTexto JSON de las claves no aplicadas.
Reemplazar variables de plantilla
variables asigna nombres de marcadores al texto de reemplazo. Los marcadores tienen la forma {{name}}.
Alcance requerido: pages:write.
Reemplazar variables de plantilla › Request Body
page_idId de la página.
Nombre del marcador al texto. También se acepta un string JSON.
Reemplazar variables de plantilla › Responses
El resultado del reemplazo.
idId de la página.
page_idId de la página.
successtrue cuando terminó.
replacement_countCantidad de reemplazos.
changed_section_countSecciones reescritas.
replaced_variablesTexto JSON de las variables reemplazadas.
remaining_variablesTexto JSON de las variables que siguen en la página.
remaining_variable_countCantidad de variables restantes.
Comprobar si la página se puede publicar
ready_to_publish es false si no hay secciones o quedan variables. Las listas se devuelven como texto JSON.
Alcance requerido: pages:read.
Comprobar si la página se puede publicar › Responses
El resultado.
idId de la página.
page_idId de la página.
ready_to_publishtrue cuando no hay problemas.
issue_countCantidad de problemas.
issuesTexto JSON de los problemas.
field_countCantidad de campos editables.
remaining_variable_countVariables que siguen en la página.
remaining_variablesTexto JSON de las variables restantes.
Publicar una página
page_id y site_id son obligatorios. slug es la ruta en el sitio. Un slug vacío publica en la raíz.
Alcance requerido: cualquiera de pages:publish, pages:write.
Publicar una página › Request Body
page_idId de la página.
site_idSitio que hospedará la página.
slugRuta en el sitio. Omite o envía vacío para la raíz.
Publicar una página › Responses
El resultado.
idId de la página.
page_idId de la página.
site_idId del sitio.
successtrue cuando la publicación tuvo éxito.
urlURL pública.
domainDominio publicado.
slugRuta publicada.
revision_savedtrue cuando se guardó una revisión.
revision_warningAviso si la revisión no se pudo guardar.
Obtener una página
Lee un borrador que todavía no aparece en la lista, y también páginas publicadas.
Alcance requerido: pages:read.
path Parameters
pageIdId de la página.
Obtener una página › Responses
La página.
idId de la página.
nameNombre visible. Incluye el sitio entre paréntesis cuando la página está en un sitio.
page_nameNombre sin el sufijo del sitio.
statuspublished o draft.
is_quiztrue cuando la página es un quiz.
project_idId del proyecto.
site_idId del sitio cuando la página está unida a un sitio.
site_nameNombre del sitio.
domainDominio publicado.
slugRuta en el sitio. Vacío significa la raíz.
urlURL pública después de publicar.
edit_urlEnlace a la página en el constructor.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
published_atHora de publicación ISO-8601.
Eliminar una página
Un borrador sin sitio se elimina directamente. Una página publicada o ya unida a un sitio se elimina a través del sitio y debe tener site id. Una página publicada sin sitio responde 400.
Alcance requerido: pages:write.
path Parameters
pageIdId de la página.
Eliminar una página › Responses
El registro fue eliminado.
successtrue cuando la eliminación tuvo éxito.
idId del registro eliminado.
deletedtrue cuando el registro se eliminó.
Listar plantillas
Alcance requerido: pages:read.
query Parameters
limitCantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.
queryTexto sin distinción de mayúsculas que se compara con el nombre y los campos relacionados.
categoryCategoría.
typeTipo. Predeterminado page.
template_idId exacto.
Listar plantillas › Responses
Registros coincidentes. El cuerpo es un arreglo JSON.
idId de la plantilla.
nameNombre.
template_nameIgual que name.
categoryCategoría.
typeTipo, normalmente page.
descriptionDescripción.
preview_urlURL de vista previa.
image_urlURL de la miniatura.
Buscar plantillas
Los mismos filtros y la misma respuesta que GET /templates.
Alcance requerido: pages:read.
query Parameters
limitCantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.
queryTexto sin distinción de mayúsculas que se compara con el nombre y los campos relacionados.
categoryCategoría.
typeTipo.
template_idId exacto.
Buscar plantillas › Responses
Registros coincidentes. El cuerpo es un arreglo JSON.
idId de la plantilla.
nameNombre.
template_nameIgual que name.
categoryCategoría.
typeTipo, normalmente page.
descriptionDescripción.
preview_urlURL de vista previa.
image_urlURL de la miniatura.
Buscar páginas
Compara nombre, título, dominio y slug. page_id devuelve un arreglo de un elemento. El límite predeterminado es 100.
Alcance requerido: pages:read.
query Parameters
limitCantidad máxima de registros. El valor predeterminado es 50 y el máximo es 100.
queryTexto sin distinción de mayúsculas que se compara con el nombre y los campos relacionados.
page_idId exacto.
Buscar páginas › Responses
Registros coincidentes. El cuerpo es un arreglo JSON.
idId de la página.
nameNombre visible. Incluye el sitio entre paréntesis cuando la página está en un sitio.
page_nameNombre sin el sufijo del sitio.
statuspublished o draft.
is_quiztrue cuando la página es un quiz.
project_idId del proyecto.
site_idId del sitio cuando la página está unida a un sitio.
site_nameNombre del sitio.
domainDominio publicado.
slugRuta en el sitio. Vacío significa la raíz.
urlURL pública después de publicar.
edit_urlEnlace a la página en el constructor.
created_atMarca de tiempo ISO-8601.
updated_atMarca de tiempo ISO-8601.
published_atHora de publicación ISO-8601.