API do CMS | HubDB

​

Limites de taxa

• Quaisquer solicitações GET que não exijam autenticação (incluindo solicitações JavaScript do lado do cliente) estão limitadas a 10 solicitações por segundo. Essas solicitações não contarão para o limite diário.
• Todas as outras solicitações usando autenticação siga as limites padrão.

​

Tabelas de rascunho e ativas

​

Criar uma tabela HubDB

// Example request
{
  "name": "test_table",
  "label": "Test Table",
  "useForPages": false,
  "allowPublicApiAccess": false,
  "allowChildTables": true,
  "enableChildTablePages": false,
  "columns": []
}

​

Adicionar colunas da tabela

// Example request
{
  "label": "Test Table",
  "name": "test_table",
  "columns": [
    {
      "name": "text_column",
      "label": "Text Column",
      "archived": false,
      "type": "TEXT"
    },
    {
      "name": "number_column",
      "label": "Number Column",
      "archived": false,
      "type": "NUMBER"
    },
    {
      "name": "multiselect",
      "label": "Multi Select Column",
      "archived": false,
      "type": "multiselect",
      "options": [
        {
          "name": "Option 1",
          "type": "option"
        },
        {
          "name": "Option 2",
          "type": "option"
        }
      ]
    }
  ],
  "useForPages": true,
  "allowChildTables": true,
  "enableChildTablePages": false,
  "allowPublicApiAccess": false
}

​

Adicionar linhas da tabela

// Example request
{
  "values": {
    "text_column": "sample text value",
    "number_column": 76,
    "rich_text_column": "<strong>This is a styled paragraph.</strong>",
    "date_column": 1591228800000,
    "date_time_column": 1604450520000,
    "boolean_column": 1,
    "select_column": {
      "name": "option 1",
      "type": "option"
    },
    "multiselect_column": [
      {
        "name": "Option 1",
        "type": "option"
      },
      {
        "name": "Option 2",
        "type": "option"
      }
    ],
    "url_column": "https://www.hubspot.com/marketing",
    "video_column": 3392210008,
    "image_column": {
      "url": "https://f.hubspotusercontentqa00.net/hubfs/99992002/image3%20(1).jpg",
      "width": 1600,
      "height": 900,
      "type": "image"
    },
    "foreign_id_column": [
      {
        "id": "4364402239",
        "type": "foreignid"
      },
      {
        "id": "4364402240",
        "type": "foreignid"
      }
    ]
  },
  "path": "test_path",
  "name": "test_title",
  "childTableId": "1902373"
}

​

Importar linhas do CSV

• config: um conjunto de opções formatadas em JSON para a importação.
• file: o arquivo CSV que você deseja importar.

// Example config JSON
{
  "skipRows": 1,
  "separator": ",",
  "idSourceColumn": 1,
  "resetTable": false,
  "columnMappings": [
    {
      "target": 1,
      "source": 2
    },
    {
      "target": 2,
      "source": "zip_code"
    }
  ],
  "primaryKeyColumn": "name",
  "encoding": "utf-8",
  "format": "csv"
}

curl -L -X POST 'https://api.hubspotqa.com/hubdb/api/v2/tables/xxxxxx/import?portalId=xxxxxxx' \
-H 'Content-Type: multipart/form-data' \
-F 'config="{\"skipRows\":1,\"format\":\"csv\",\"separator\":\",\",\"encoding\":\"iso-8859-1\",\"columnMappings\":[{\"target\":1,\"source\":7},{\"target\":3,\"source\":8}],\"idSourceColumn\":1,\"pathSourceColumn\":null,\"nameSourceColumn\":null,\"childTableSourceColumn\":null,\"resetTable\":true}"' \
-F 'file=@"/Users/xxxxxxxxxxxxx/Downloads/filename.csv"'

​

Formatação de data

• yyyy/mm/dd
• yyyy/mm/dd
• mm/dd/yyyy
• mm/dd/yy

• The 1st of March in the year 2022
• Fri Mar 4 2022
• March 4th '22

• next Thursday
• Today
• tomorrow
• 3 days from now

​

Redefinir opções

• Se resetTable estiver definido como true:
  • Se as linhas no arquivo CSV não tiverem uma coluna de ID de linha (hs_id ou o ID da linha for especificado como 0, essas linhas serão inseridas com os novos IDs de linha gerados.
  • Se os IDs de linha no arquivo CSV já existirem na tabela de destino, as linhas existentes na tabela serão atualizadas com os novos valores do arquivo de entrada.
  • Se a tabela tiver linhas, mas o arquivo CSV de entrada não tiver os IDs dessas linha, as linhas serão excluídas da tabela de destino.
  • Se os IDs de linha no arquivo CSV de entrada não existirem na tabela de destino, essas linhas serão inseridas com os novos IDs de linha gerados e os IDs de linha fornecidos no arquivo de entrada serão ignorados.
  • Se o arquivo CSV de entrada não contiver a coluna de ID de linha, todas as linhas serão excluídas da tabela de destino e as linhas do arquivo de entrada serão inseridas com os novos IDs de linha gerados.
• Se resetTable estiver definido como false (padrão):
  • Se os IDs de linha no arquivo CSV já existirem na tabela de destino, as linhas existentes na tabela serão atualizadas com os novos valores do arquivo de entrada.
  • Se a tabela tiver linhas, mas o arquivo CSV de entrada não tiver os IDs dessas linhas, as linhas não serão excluídas da tabela de destino e permanecerão inalteradas.
  • Se os IDs de linha no arquivo CSV de entrada não existirem na tabela de destino, essas linhas serão inseridas com os novos IDs de linha gerados e os IDs de linha fornecidos no arquivo de entrada serão ignorados.
  • Se as linhas no arquivo CSV não tiverem uma coluna de ID de linha ou se o ID de linha for especificado como 0, essas linhas serão inseridas com os novos IDs de linha gerados.

​

Recuperar dados do HubDB

• Para recuperar detalhes de todas as tabelas publicadas, faça uma solicitação GET para /cms/v3/hubdb/tables.
• Para recuperar os detalhes de uma tabela publicada específica, faça uma solicitação GET para /cms/v3/hubdb/tables{tableIdOrName}.
• Para recuperar todas as linhas de uma tabela específica, faça uma solicitação GET para /cms/v3/hubdb/tables{tableIdOrName}/rows.
• Para recuperar uma linha específica de uma tabela, faça uma solicitação GET para /cms/v3/hubdb/tables{tableIdOrName}/rows/{rowId}.

​

Filtrar linhas retornadas

• Ao transmitir valores para colunas multiselect, eles devem ser separados por vírgulas (por exemplo, multiselect_column__contains=1,2).
• Para filtros datetime, você pode usar datas relativas no lugar de data/hora para especificar um valor relativo à hora atual. Por exemplo, -3h corresponderia à data e hora de 3 horas antes, ao passo que 10s corresponderia a 10 segundos no futuro. As unidades de tempo suportadas são ms (milissegundos), s (segundos), m (minutos), h (horas), d (dias). A hora atual pode ser usada especificando um valor zero: 0s
• Para efeitos destes filtros, a coluna incorporada hs_id é uma coluna number, a coluna hs_created_at é datetime e as colunas hs_path e hs_name são colunas text.

​

Classificar as linhas retornadas

• geo_distance(location_column_name, latitude, longitude): pega o nome de uma coluna de localização e as coordenadas, retorna as linhas ordenadas por quão longe os valores da coluna de localização especificada estão das coordenadas fornecidas.
• length(column_name): pega o nome de uma coluna, retorna as linhas ordenadas pelo comprimento do valor da coluna (calculado como uma string)
• random(): retorna as linhas em ordem aleatória.

​

Configurar tabelas HubDB para páginas dinâmicas

// Example POST request to create table
{
  "name": "dynamic_page_table",
  "label": "Dynamic page table",
  "useForPages": true,
  "columns": [
    {
      "name": "meta_description",
      "label": "Meta description",
      "archived": false,
      "type": "TEXT"
    },
    {
      "name": "featured_image",
      "label": "Featured image",
      "archived": false,
      "type": "IMAGE"
    },
    {
      "name": "canonical_url",
      "label": "Canonical URL",
      "archived": false,
      "type": "URL"
    }
  ],
  "dynamicMetaTags": {
    "DESCRIPTION": 1,
    "FEATURED_IMAGE_URL": 2,
    "LINK_REL_CANONICAL_URL": 3
  }
}

​

Alterações na V3

• As tabelas devem ter name e label. Este nome não pode ser alterado após a criação da tabela. Os nomes somente podem incluir letras minúsculas, dígitos e sublinhados e não podem começar com um número. Ambos name e label devem ser exclusivos na conta.
• A API oferece suporte a ambas as tabelas id e name nos caminhos de URL.
• GET pontos de extremidade da linha retornam o nameda coluna em vez de id no campo values. Além disso, os pontos de extremidade de linha POST / PUT / PATCH exigem a coluna name em vez de id no campo values.
• Os pontos de extremidade de atualização PATCH agora aceitam atualizações esparsas, o que significa que você pode especificar apenas os valores de coluna que precisa atualizar (nas versões anteriores, era necessário especificar todos os valores de coluna). Quando você atualiza uma coluna com uma lista de valores, como seleção múltipla, é necessário especificar a lista de todos os valores. Para excluir o valor de uma coluna, você precisa especificar a coluna com o valor como null na solicitação.
• Removidos os pontos de extremidade para get / update / delete uma célula de linha em favor de pontos de extremidade de atualização PATCH para linhas.
• O recurso para importar ponto de extremidade agora dá suporte a um campo opcional idSourceColumn, juntamente com os campos existentes nas opções formatadas em JSON. Você pode usar esse campo para especificar a coluna no arquivo csv que contém ids de linha. Para importar novas linhas, juntamente com os novos valores para as linhas existentes, você pode simplesmente especificar 0 como o id para as novas linhas e os ids de linha válidos para as colunas existentes. Veja mais detalhes na seção Importar abaixo. Também é possível usar nomes ou ids de coluna no campo de destino dos mapeamentos de coluna nas opções formatadas em JSON.
• O clone de ponto de extremidade requer um novo nome e um novo rótulo.