Pular para o conteúdo principal
POST
Pesquisa em redes sociais
Cada modo retorna output normalizado, compartilhado pelas seis plataformas. A saída nativa do Provider não é repetida nele; ela permanece no Run e pode ser lida com Get Run. Um valor que uma plataforma ou o Provider não informa é null. Leia result_status separadamente de status: success, no_result, error ou pending. Uma resposta vazia, mas válida, é no_result e mantém o formato do modo: items ou profiles é [], ou todos os campos são null. charge_usd totaliza runs desta resposta. Para uma rota do Apify pendente (HTTP 202), siga o result_url autenticado. Consulte Seleção de Provider e cobranças.

Saída por modo

Os campos seguem as convenções de campos.
  • published_at está em UTC ISO 8601, ou null quando o Provider não fornece um horário exato (resultados de pesquisa do YouTube).
  • title é o título do Reddit ou do YouTube. text é apenas o corpo (o texto da própria publicação no Reddit, a descrição do YouTube, o tweet, a legenda ou o texto da publicação), e é null quando não há nenhum.
  • bio é a descrição em texto livre (no LinkedIn: a seção About). headline é a linha do cargo no LinkedIn. website é o site da própria conta: o site da empresa no LinkedIn ou o link expandido do perfil no X.
  • likes é a pontuação líquida do Reddit (pode ser negativa), os favoritos do X, os diggs do TikTok ou as curtidas e reações nas demais plataformas. shares são os retweets do X, os envios pela folha de compartilhamento do TikTok ou as republicações do LinkedIn. views são as impressões do X, as reproduções do TikTok ou as visualizações de vídeos do YouTube e do Instagram.
  • Em find, platform é o nome da rede em minúsculas (twitter torna-se x), e handle pode ser usado como o handle de social_research. scrapecreators_confidence é a pontuação de 0 a 1 da ScrapeCreators por perfil. pdl_likelihood é a pontuação de correspondência de 1 a 10 da People Data Labs para a pessoa inteira, preenchida somente em linkedin.find.
  • O id do LinkedIn é o id básico da atividade, sem o prefixo urn:li:activity:.

Cabeçalhos

idempotency-key
string
obrigatório

Gere um valor exclusivo para cada execução pretendida (recomenda-se um UUID). Tente novamente com a mesma chave e os mesmos parâmetros de execução para recuperar o Run original sem uma segunda cobrança. Alterar os parâmetros de execução usando a mesma chave retorna 409; alterar task_id ou metadata não atualiza o Run original.

Minimum string length: 1

Corpo

application/json
platform
enum<string>
obrigatório
Opções disponíveis:
reddit,
x,
youtube,
tiktok,
instagram,
linkedin
mode
enum<string> | null

Padrão: search. Todas as plataformas são compatíveis com cada modo.

  • search: publicações que correspondem à consulta.
  • profile: detalhes da conta a partir do handle (Reddit: subreddit). Para o LinkedIn, forneça uma URL de pessoa ou empresa.
  • feed: publicações ou vídeos recentes a partir do handle. Para o LinkedIn, forneça uma URL de empresa.
  • post: uma publicação ou vídeo a partir da URL.
  • find: outros perfis sociais a partir do handle. Para o LinkedIn, forneça a URL do perfil de uma pessoa; para o Reddit, forneça uma consulta para encontrar subreddits.
Opções disponíveis:
search,
profile,
feed,
post,
find
provider
enum<string> | null

Padrão auto: seleciona o primeiro provedor de dados elegível na ordem de preferência da Glasser. Um provedor de dados nomeado deve aceitar a solicitação e ser permitido pela sua Key; não há fallback para outro provedor de dados. Os valores disponíveis estão listados abaixo.

Opções disponíveis:
auto,
scrapecreators,
apify,
tikhub,
pdl
query
string | null
Required string length: 1 - 500
handle
string | null

Um nome de usuário sem @ ou um nome de subreddit sem r/.

Required string length: 1 - 100
url
string | null
Required string length: 1 - 2048
task_id
string | null

Agrupe Runs relacionados, incluindo o fallback automático, em um único Task. Reutilize uma string estável e filtre a lista de Runs por task para recuperá-los.

metadata

Campos opcionais de acompanhamento, retornados no Run e disponíveis como filtros. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.

Entradas inválidas são descartadas por inteiro, não truncadas. A solicitação continua, e o Run retorna os campos que foram armazenados.

Resposta

Success

id
string
obrigatório
run_url
string
obrigatório

Abra este Run no console. Requer associação ao Workspace.

provider
string
obrigatório
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
obrigatório
Pattern: ^\/.+$
endpoint_version
integer
obrigatório
status
enum<string>
obrigatório

QUEUED ou RUNNING: ainda em andamento. COMPLETED: uma resposta do provedor de dados está disponível, incluindo respostas não 2xx. FAILED: consulte failure. STOPPED: interrompido antes do despacho. Leia charge_usd separadamente de status.

Opções disponíveis:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
obrigatório

Motivo da falha do Run. Não nulo somente quando status é FAILED.

input
object
obrigatório
output
object
obrigatório

Campos normalizados por modo, compartilhados por todas as plataformas. A saída nativa do provedor de dados não é repetida aqui; ela permanece no Run (GET /v1/runs/:id). Os valores que uma plataforma ou o provedor de dados não informa são nulos.

  • profile: platform, handle, name, url, bio, headline, website, followers, following, posts, verified
  • search: items[]: id, url, title, text, author, author_url, published_at, likes, comments, shares, views
  • feed: items[]: os mesmos campos de publicação de search
  • post: id, url, title, text, author, author_url, published_at, likes, comments, shares, views
  • find: profiles[]: platform, url, handle, scrapecreators_confidence, followers (Reddit: subreddits correspondentes); pdl_likelihood
provider_response
object | null
obrigatório

Não nulo somente quando status é COMPLETED.

  • Para respostas 2xx, output contém JSON nativo do provedor de dados (qualquer formato) ou nulo para um corpo vazio.
  • Para respostas não 2xx, error contém o corpo de erro do provedor de dados e output é nulo.

Os campos sensíveis são removidos de ambos os corpos.

charge_usd
string | null
obrigatório

Cobrança total dos Runs nesta resposta de Solution. Nulo até que todos os Runs listados sejam liquidados. Cada Run mantém sua própria cobrança; falhas também podem ser cobradas.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
obrigatório

Base de cobrança de um único Run ou nulo para um total de vários Runs. Leia runs[].charge_basis para cada cobrança.

stoppable
boolean
obrigatório

Indica se uma solicitação de interrupção pode ser aceita atualmente. Isso não garante que o Run possa ser interrompido antes do despacho.

stop_requested_at
string<date-time> | null
obrigatório

Quando uma interrupção foi solicitada. O Run ainda pode continuar se o despacho já tiver começado.

created_at
string<date-time>
obrigatório

carimbo de data e hora UTC ISO-8601

started_at
string<date-time> | null
obrigatório

carimbo de data e hora UTC ISO-8601

completed_at
string<date-time> | null
obrigatório

carimbo de data e hora UTC ISO-8601

task_id
string | null
obrigatório
metadata
object
obrigatório

Seus campos de acompanhamento armazenados. Use-os para filtrar Runs. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.
action
string
obrigatório

<platform>.<mode>; uma página de empresa do LinkedIn no modo de perfil é linkedin.company.

Pattern: ^[a-z]+\.[a-z]+$
result_status
enum<string>
obrigatório

Status de entrega comercial, independente do ciclo de vida final do Run em status. no_result é uma resposta vazia, mas válida; error significa que não foi possível entregar a saída do provedor de dados.

Opções disponíveis:
success,
no_result,
error,
pending
error
object | null
obrigatório
runs
object[]
obrigatório
result_url
string
obrigatório

Caminho de URL autenticado e somente leitura para consultar este resultado normalizado e a cobrança total. Use com a origem da API. Não cria Runs nem retoma o fallback. GET /v1/runs/:id ainda retorna o Run nativo e individual.