Referência das ferramentas
Corpus
Ler o corpus e o workspace. 22 ferramentas, com seus parâmetros e exemplos de chamada.
Ferramentas do agente Piqline. Elas leem o que o workspace já coletou: sem consumo de créditos, nada é gravado.
Cada chamada é uma requisição POST com a chave em Authorization: Bearer. O corpo JSON é a entrada da ferramenta, e a resposta tem o formato { "tool": "nom", "output": … }. Os exemplos trazem apenas os parâmetros obrigatórios. As descrições dos parâmetros são as que os agentes leem.
getCoverageStats#
Volumes e saúde da coleta: totais, divisão por plataforma e por tipo, séries de ingestão na janela de análise (1h, 24h, 7d ou 30d).
POSThttps://piqline.com/api/v1/tools/getCoverageStats
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
period | 1h | 24h | 7d | 30d | Não | Analysis window |
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/getCoverageStats", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getCoverageStats",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]listSources#
Fontes que o workspace acompanha, com número de itens, saúde e última leitura.
POSThttps://piqline.com/api/v1/tools/listSources
Tipo: Leitura. Scopes: read.
Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.
curl -s https://piqline.com/api/v1/tools/listSources \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listSources", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listSources",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]searchItems#
Busca itens (posts, vídeos, artigos, anúncios, vagas) com filtros: texto, plataforma, tipo, fonte. Sem filtro, devolve os mais recentes (40 no máximo).
POSThttps://piqline.com/api/v1/tools/searchItems
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Free-text match on title and body |
platform | string | Não | |
itemType | post | video | article | listing | job_offer | Não | |
sourceId | string | Não | |
limit | integer | Não |
curl -s https://piqline.com/api/v1/tools/searchItems \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/searchItems", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/searchItems",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]getItem#
Detalhe de um item: texto, transcrição, OCR, temas detectados, itens próximos em significado e suas datas de observação.
POSThttps://piqline.com/api/v1/tools/getItem
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
itemId | string | Sim |
curl -s https://piqline.com/api/v1/tools/getItem \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'const response = await fetch("https://piqline.com/api/v1/tools/getItem", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getItem",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]searchPassages#
Busca por significado em documentos longos (PDFs lidos pelo Motor): as passagens mais próximas de uma pergunta, com o item, a página e o título da seção.
POSThttps://piqline.com/api/v1/tools/searchPassages
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Sim | Question or phrase to look for |
itemId | string | Não | Limit to one document |
limit | integer | Não |
curl -s https://piqline.com/api/v1/tools/searchPassages \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"levée de fonds"}'const response = await fetch("https://piqline.com/api/v1/tools/searchPassages", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": "levée de fonds"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/searchPassages",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"query": "levée de fonds",
},
)
output = response.json()["output"]citeItem#
Verifica se uma passagem aparece palavra por palavra em um item e devolve um número de citação; caso contrário, a passagem mais próxima. Base do modo Citações do chat.
POSThttps://piqline.com/api/v1/tools/citeItem
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
itemId | string | Sim | Item id from searchItems or getItem |
quote | string | Sim | Exact passage copied from the item text |
curl -s https://piqline.com/api/v1/tools/citeItem \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","quote":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/citeItem", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"quote": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/citeItem",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"quote": "texte",
},
)
output = response.json()["output"]drawDiagram#
Desenha a resposta como um diagrama SVG (linha do tempo, matriz, fluxo, árvore…): cores por papel do tema, SVG sanitizado antes da exibição. Base do modo Diagrama do chat.
POSThttps://piqline.com/api/v1/tools/drawDiagram
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | architecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | … | Sim | Visual type chosen for the layout |
title | string | Sim | Short name of the subject, in the user's language |
description | string | Sim | One sentence on what the diagram shows, for screen readers and the caption |
svg | string | Sim | A single <svg viewBox="0 0 960 H">…</svg> following the diagram rules |
curl -s https://piqline.com/api/v1/tools/drawDiagram \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"type":"architecture","title":"texte","description":"texte","svg":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/drawDiagram", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"type": "architecture",
"title": "texte",
"description": "texte",
"svg": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/drawDiagram",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"type": "architecture",
"title": "texte",
"description": "texte",
"svg": "texte",
},
)
output = response.json()["output"]createCanvas#
Compila um canvas (um arquivo TSX que só importa o SDK piqline/canvas) e devolve código pronto para exibir, ou o erro a corrigir. Base dos modos Canvas e Relatório do chat.
POSThttps://piqline.com/api/v1/tools/createCanvas
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | Short title shown above the canvas, in French |
source | string | Sim | Full .canvas.tsx source |
curl -s https://piqline.com/api/v1/tools/createCanvas \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"texte","source":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/createCanvas", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"title": "texte",
"source": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/createCanvas",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"title": "texte",
"source": "texte",
},
)
output = response.json()["output"]getTopics#
Temas detectados com sua parcela de voz e histórias (o mesmo assunto visto em várias fontes).
POSThttps://piqline.com/api/v1/tools/getTopics
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
period | 1h | 24h | 7d | 30d | Não | Analysis window |
curl -s https://piqline.com/api/v1/tools/getTopics \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/getTopics", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getTopics",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]getSignals#
Sinais abertos, disparados pelas regras de persistência do workspace, com seu prazo e status.
POSThttps://piqline.com/api/v1/tools/getSignals
Tipo: Leitura. Scopes: read.
Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.
curl -s https://piqline.com/api/v1/tools/getSignals \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/getSignals", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getSignals",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]listWorkspaceTables#
Tabelas já criadas no workspace: nome, comentário, número de colunas e linhas, e se a tabela se preenche sozinha.
POSThttps://piqline.com/api/v1/tools/listWorkspaceTables
Tipo: Leitura. Scopes: read.
Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.
curl -s https://piqline.com/api/v1/tools/listWorkspaceTables \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listWorkspaceTables", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listWorkspaceTables",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]getWorkspaceTable#
Uma tabela do workspace em JSON: esquema, colunas e linhas. Serve de base ou de alimentação para um site, um app ou um agente (scope read).
POSThttps://piqline.com/api/v1/tools/getWorkspaceTable
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
schema | string | Não | Schema, default public. |
name | string | Sim | Table name. |
curl -s https://piqline.com/api/v1/tools/getWorkspaceTable \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/getWorkspaceTable", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getWorkspaceTable",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"name": "texte",
},
)
output = response.json()["output"]listBookmarks#
Favoritos e pastas do cofre do workspace: título, tipo, pasta, status, admissão. Filtro opcional por palavra, status ou tipo.
POSThttps://piqline.com/api/v1/tools/listBookmarks
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Optional filter on title, note or tags. |
status | inbox | reading | done | Não | |
kind | item | source | signal | graph | search | document | board | chat | Não |
curl -s https://piqline.com/api/v1/tools/listBookmarks \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listBookmarks", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listBookmarks",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]listEntities#
Entidades acompanhadas (empresas, marcas, contas públicas) e itens vinculados no período.
POSThttps://piqline.com/api/v1/tools/listEntities
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
period | 7d | 30d | 90d | Não |
curl -s https://piqline.com/api/v1/tools/listEntities \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listEntities", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listEntities",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]listWatchContracts#
Contratos de monitoramento definidos nas fontes: intenção, termos mantidos e excluídos, evento.
POSThttps://piqline.com/api/v1/tools/listWatchContracts
Tipo: Leitura. Scopes: read.
Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.
curl -s https://piqline.com/api/v1/tools/listWatchContracts \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listWatchContracts", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listWatchContracts",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]checkInvestigation#
Status da última investigação Edge, ou de uma específica: pendente, em execução, concluída com seus candidatos, ou falha.
POSThttps://piqline.com/api/v1/tools/checkInvestigation
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
missionId | string | Não | Omit to read the latest investigator mission of this workspace |
curl -s https://piqline.com/api/v1/tools/checkInvestigation \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/checkInvestigation", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/checkInvestigation",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]checkHunt#
Status da última busca, ou de uma específica: etapa, pessoas encontradas com o veredito do código e o seu, e para cada critério seu status e sua prova pública datada (URL, data, trecho). Nunca dados de contato.
POSThttps://piqline.com/api/v1/tools/checkHunt
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
missionId | string | Não | Omit to read the latest hunt of this workspace. |
curl -s https://piqline.com/api/v1/tools/checkHunt \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/checkHunt", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/checkHunt",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]planSourcePack#
Propõe um conjunto coerente de fontes a acompanhar para um objetivo. Não cria nada.
POSThttps://piqline.com/api/v1/tools/planSourcePack
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | |
rationale | string | Sim | Why this pack answers the goal |
candidates | array<object> | Sim |
curl -s https://piqline.com/api/v1/tools/planSourcePack \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"texte","rationale":"texte","candidates":[{"platform":"instagram","target":"texte","label":"texte","why":"texte","confidence":"high"}]}'const response = await fetch("https://piqline.com/api/v1/tools/planSourcePack", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "texte",
"rationale": "texte",
"candidates": [
{
"platform": "instagram",
"target": "texte",
"label": "texte",
"why": "texte",
"confidence": "high"
}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/planSourcePack",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"name": "texte",
"rationale": "texte",
"candidates": [
{
"platform": "instagram",
"target": "texte",
"label": "texte",
"why": "texte",
"confidence": "high",
},
],
},
)
output = response.json()["output"]listWidgets#
Widgets que podem entrar em um board deste workspace, classificados para a pessoa, com seus motivos.
POSThttps://piqline.com/api/v1/tools/listWidgets
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
period | 7d | 30d | 90d | Não | Window used by isProposable. Default 7d. |
curl -s https://piqline.com/api/v1/tools/listWidgets \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listWidgets", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listWidgets",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]getAdvertiserCampaigns#
Dossiê de anúncios de um anunciante a partir das coletas do workspace: anúncios, ativos, datas, bibliotecas, países, necessidades lidas, novos anúncios por mês e aumentos de ritmo, últimos anúncios, sinais. Nunca uma pessoa. Sem créditos.
POSThttps://piqline.com/api/v1/tools/getAdvertiserCampaigns
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
advertiser | string | Sim | Name (or part of it) of the advertiser. |
curl -s https://piqline.com/api/v1/tools/getAdvertiserCampaigns \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"advertiser":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/getAdvertiserCampaigns", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"advertiser": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getAdvertiserCampaigns",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"advertiser": "texte",
},
)
output = response.json()["output"]listAdSignals#
Sinais de anúncios do workspace, calculados a cada hora: campanha iniciada ou encerrada, aumento de ritmo, novo país, nova plataforma, contratação paga, promoção, lançamento, novo anunciante. Sem créditos.
POSThttps://piqline.com/api/v1/tools/listAdSignals
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
kind | ad_campaign_started | ad_campaign_stopped | ad_ramp_up | ad_new_country | ad_new_platform | ad_hiring | ad_promotion | ad_launch | … | Não | ad_hiring for paid recruitment campaigns, ad_campaign_started for new campaigns, etc. |
activeOnly | boolean | Não | |
limit | integer | Não |
curl -s https://piqline.com/api/v1/tools/listAdSignals \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listAdSignals", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listAdSignals",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]listCollectedAds#
Coletas de anúncios do workspace (Meta, TikTok, Google, LinkedIn), já lidas: a lista ou, com o nome de uma coleta, suas divisões (ângulos, ofertas, tons, formatos), seu ritmo, seus anúncios mais duradouros e seus anúncios filtrados por biblioteca, status, ângulo ou palavra. Sem créditos.
POSThttps://piqline.com/api/v1/tools/listCollectedAds
Tipo: Leitura. Scopes: read.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
collection | string | Não | Name of a collection (exact, start or fragment). |
library | meta | tiktok | google | linkedin | Não | |
status | live | new | Não | live: active or shown within 14 days. new: first seen at the last pass. |
angle | promotion | lancement | marque | preuve_sociale | education | recrutement | evenement | lead | … | Não | |
query | string | Não | Word to find in the advertiser, title, text, button or transcript. |
limit | integer | Não |
curl -s https://piqline.com/api/v1/tools/listCollectedAds \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/listCollectedAds", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/listCollectedAds",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]