Listar páginas
Escopo exigido: pages:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
pageÍndice de página começando em zero. A API devolve limit registros a partir de page × limit.
project_idApenas registros deste projeto.
site_idApenas páginas deste site.
publishedtrue para publicadas, false para rascunhos.
is_quiztrue para devolver apenas quizzes.
has_elementApenas páginas cujo construtor contém este tipo de elemento.
available_for_funneltrue para ocultar páginas que já estão em um funil.
Listar páginas › Responses
Registros correspondentes. O corpo é um array JSON.
idId da página.
nameNome de exibição. Inclui o site entre parênteses quando a página está em um site.
page_nameNome sem o sufixo do site.
statuspublished ou draft.
is_quiztrue quando a página é um quiz.
project_idId do projeto.
site_idId do site quando a página está ligada a um site.
site_nameNome do site.
domainDomínio publicado.
slugCaminho no site. Vazio significa a raiz.
urlURL pública depois de publicar.
edit_urlLink da página no construtor.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
published_atHora de publicação ISO-8601.
Criar uma página em branco
Cria um rascunho. Publique depois com POST /pages/publish.
Escopo exigido: pages:write.
Criar uma página em branco › Responses
A página criada.
idId da página.
nameNome de exibição. Inclui o site entre parênteses quando a página está em um site.
page_nameNome sem o sufixo do site.
statuspublished ou draft.
is_quiztrue quando a página é um quiz.
project_idId do projeto.
site_idId do site quando a página está ligada a um site.
site_nameNome do site.
domainDomínio publicado.
slugCaminho no site. Vazio significa a raiz.
urlURL pública depois de publicar.
edit_urlLink da página no construtor.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
published_atHora de publicação ISO-8601.
Criar uma página a partir de um modelo
Escopo exigido: pages:write.
Criar uma página a partir de um modelo › Request Body
template_idId do modelo de GET /templates.
nameNome da nova página.
site_idSite para ligar, se houver.
project_idId do projeto.
Criar uma página a partir de um modelo › Responses
A página clonada.
idId da página.
nameNome de exibição. Inclui o site entre parênteses quando a página está em um site.
page_nameNome sem o sufixo do site.
statuspublished ou draft.
is_quiztrue quando a página é um quiz.
project_idId do projeto.
site_idId do site quando a página está ligada a um site.
site_nameNome do site.
domainDomínio publicado.
slugCaminho no site. Vazio significa a raiz.
urlURL pública depois de publicar.
edit_urlLink da página no construtor.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
published_atHora de publicação ISO-8601.
Duplicar uma página
Atualizar metadados da página
page_id é obrigatório, mais pelo menos um entre name, project_id, tags ou product_label. tags pode ser um array ou texto separado por vírgulas.
Escopo exigido: pages:write.
Atualizar metadados da página › Request Body
page_idId da página.
nameNovo nome.
project_idNovo id de projeto.
tagsArray de tags, ou texto separado por vírgulas.
product_labelRótulo de produto. produkt é aceito como alias.
Atualizar metadados da página › Responses
Os metadados atualizados.
idId da página.
page_idId da página.
updatedtrue quando foi salvo.
nameNome depois da atualização.
project_idId de projeto depois da atualização.
tagsTags depois da atualização.
product_labelRótulo depois da atualização.
Atualizar conteúdo mapeado
updates é um objeto com as chaves do mapa de conteúdo. Leia-as em GET /search/page-content-map. Chaves desconhecidas voltam em missing e não são aplicadas.
Escopo exigido: pages:write.
Atualizar conteúdo mapeado › Request Body
page_idId da página.
Mapa de chaves de conteúdo para novos valores. Um string JSON também é aceito.
Atualizar conteúdo mapeado › Responses
O resultado da atualização.
idId da página.
page_idId da página.
successtrue quando a solicitação terminou.
applied_countQuantidade de campos atualizados.
changed_section_countQuantidade de seções reescritas.
missing_countQuantidade de chaves não encontradas.
appliedTexto JSON das atualizações aplicadas.
missingTexto JSON das chaves não aplicadas.
Substituir variáveis do modelo
variables mapeia nomes de marcadores para o texto substituto. Os marcadores têm a forma {{name}}.
Escopo exigido: pages:write.
Substituir variáveis do modelo › Request Body
page_idId da página.
Nome do marcador para o texto. Um string JSON também é aceito.
Substituir variáveis do modelo › Responses
O resultado da substituição.
idId da página.
page_idId da página.
successtrue quando terminou.
replacement_countQuantidade de substituições.
changed_section_countSeções reescritas.
replaced_variablesTexto JSON das variáveis substituídas.
remaining_variablesTexto JSON das variáveis que ainda estão na página.
remaining_variable_countQuantidade de variáveis restantes.
Verificar se a página pode ser publicada
ready_to_publish é false se não há seções ou restam variáveis. As listas voltam como texto JSON.
Escopo exigido: pages:read.
Verificar se a página pode ser publicada › Responses
O resultado.
idId da página.
page_idId da página.
ready_to_publishtrue quando não há problemas.
issue_countQuantidade de problemas.
issuesTexto JSON dos problemas.
field_countQuantidade de campos editáveis.
remaining_variable_countVariáveis que ainda estão na página.
remaining_variablesTexto JSON das variáveis restantes.
Publicar uma página
page_id e site_id são obrigatórios. slug é o caminho no site. Um slug vazio publica na raiz.
Escopo exigido: qualquer um de pages:publish, pages:write.
Publicar uma página › Request Body
page_idId da página.
site_idSite que vai hospedar a página.
slugCaminho no site. Omita ou envie vazio para a raiz.
Publicar uma página › Responses
O resultado.
idId da página.
page_idId da página.
site_idId do site.
successtrue quando a publicação teve sucesso.
urlURL pública.
domainDomínio publicado.
slugCaminho publicado.
revision_savedtrue quando uma revisão foi salva.
revision_warningAviso se a revisão não pôde ser salva.
Obter uma página
Lê um rascunho que ainda não aparece na lista, e também páginas publicadas.
Escopo exigido: pages:read.
path Parameters
pageIdId da página.
Obter uma página › Responses
A página.
idId da página.
nameNome de exibição. Inclui o site entre parênteses quando a página está em um site.
page_nameNome sem o sufixo do site.
statuspublished ou draft.
is_quiztrue quando a página é um quiz.
project_idId do projeto.
site_idId do site quando a página está ligada a um site.
site_nameNome do site.
domainDomínio publicado.
slugCaminho no site. Vazio significa a raiz.
urlURL pública depois de publicar.
edit_urlLink da página no construtor.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
published_atHora de publicação ISO-8601.
Excluir uma página
Um rascunho sem site é excluído diretamente. Uma página publicada ou já ligada a um site é excluída pelo site e precisa ter site id. Uma página publicada sem site responde 400.
Escopo exigido: pages:write.
path Parameters
pageIdId da página.
Excluir uma página › Responses
O registro foi excluído.
successtrue quando a exclusão teve sucesso.
idId do registro excluído.
deletedtrue quando o registro foi removido.
Listar modelos
Escopo exigido: pages:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
queryTexto sem distinção de maiúsculas comparado com o nome e os campos relacionados.
categoryCategoria.
typeTipo. Padrão page.
template_idId exato.
Listar modelos › Responses
Registros correspondentes. O corpo é um array JSON.
idId do modelo.
nameNome.
template_nameIgual a name.
categoryCategoria.
typeTipo, normalmente page.
descriptionDescrição.
preview_urlURL de pré-visualização.
image_urlURL da miniatura.
Buscar modelos
Os mesmos filtros e a mesma resposta de GET /templates.
Escopo exigido: pages:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
queryTexto sem distinção de maiúsculas comparado com o nome e os campos relacionados.
categoryCategoria.
typeTipo.
template_idId exato.
Buscar modelos › Responses
Registros correspondentes. O corpo é um array JSON.
idId do modelo.
nameNome.
template_nameIgual a name.
categoryCategoria.
typeTipo, normalmente page.
descriptionDescrição.
preview_urlURL de pré-visualização.
image_urlURL da miniatura.
Buscar páginas
Compara nome, título, domínio e slug. page_id devolve um array de um item. O limite padrão é 100.
Escopo exigido: pages:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
queryTexto sem distinção de maiúsculas comparado com o nome e os campos relacionados.
page_idId exato.
Buscar páginas › Responses
Registros correspondentes. O corpo é um array JSON.
idId da página.
nameNome de exibição. Inclui o site entre parênteses quando a página está em um site.
page_nameNome sem o sufixo do site.
statuspublished ou draft.
is_quiztrue quando a página é um quiz.
project_idId do projeto.
site_idId do site quando a página está ligada a um site.
site_nameNome do site.
domainDomínio publicado.
slugCaminho no site. Vazio significa a raiz.
urlURL pública depois de publicar.
edit_urlLink da página no construtor.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
published_atHora de publicação ISO-8601.