Início rápido

Este guia orienta você na criação de um batch compliance job para verificar o status de compliance de Posts ou usuários.

Pré-requisitosAntes de começar, você precisará de:

Uma conta de desenvolvedor com um App aprovado
O Bearer Token do seu App

Criar um job

Crie um novo compliance job especificando o tipo (tweets ou users):

cURL
Python

curl -X POST "https://api.x.com/2/compliance/jobs" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "tweets",
    "name": "my-compliance-job"
  }'

import requests

bearer_token = "YOUR_BEARER_TOKEN"

url = "https://api.x.com/2/compliance/jobs"
headers = {
    "Authorization": f"Bearer {bearer_token}",
    "Content-Type": "application/json"
}
payload = {
    "type": "tweets",
    "name": "my-compliance-job"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Resposta:

{
  "data": {
    "id": "1234567890",
    "type": "tweets",
    "name": "my-compliance-job",
    "status": "created",
    "upload_url": "https://storage.googleapis.com/...",
    "download_url": "https://storage.googleapis.com/...",
    "created_at": "2024-01-15T10:00:00.000Z"
  }
}

Salve o upload_url e o download_url para as próximas etapas.

Prepare seu arquivo de dados

Crie um arquivo de texto com um ID por linha:

Salve como ids.txt.

Envie seus dados

Faça upload do arquivo para o upload_url fornecido:

curl -X PUT "UPLOAD_URL_FROM_RESPONSE" \
  -H "Content-Type: text/plain" \
  --data-binary @ids.txt

Verificar o status do job

Consulte o status do job até que ele seja concluído:

curl "https://api.x.com/2/compliance/jobs/1234567890" \
  -H "Authorization: Bearer $BEARER_TOKEN"

Status do job:

Status	Descrição
`created`	Job criado, aguardando upload
`in_progress`	Processando os dados
`complete`	Resultados prontos para download
`failed`	Job falhou
`expired`	Job expirou antes da conclusão

Baixar os resultados

Assim que o status for complete, baixe a partir do download_url:

curl "DOWNLOAD_URL_FROM_RESPONSE" -o results.json

Formato do resultado (um objeto JSON por linha):

{"id": "1234567890", "action": "delete", "created_at": "2024-01-10T12:00:00.000Z", "redacted_at": "2024-01-12T08:30:00.000Z", "reason": "deleted"}
{"id": "1234567891", "action": "delete", "created_at": "2024-01-10T12:00:00.000Z", "redacted_at": "2024-01-13T14:20:00.000Z", "reason": "suspended"}

Somente IDs com eventos de compliance aparecem nos resultados. IDs que não aparecem nos resultados ainda são válidos.

Ações de compliance

Eventos de compliance de Posts

Ação	Motivo	Descrição
`delete`	`deleted`	Post foi excluído
`delete`	`bounced`	Post falhou na verificação de compliance
`delete`	`protected`	Conta se tornou protegida
`delete`	`suspended`	Conta foi suspensa
`delete`	`scrub_geo`	Dados de geolocalização foram removidos

Eventos de compliance de usuários

Ação	Motivo	Descrição
`delete`	`deleted`	Conta foi excluída
`delete`	`suspended`	Conta foi suspensa
`delete`	`protected`	Conta se tornou protegida
`delete`	`deactivated`	Conta foi desativada

Listar todos os jobs

Obtenha todos os compliance jobs do seu App:

curl "https://api.x.com/2/compliance/jobs?type=tweets" \
  -H "Authorization: Bearer $BEARER_TOKEN"

Próximos passos

Guia de integração

Conceitos-chave e melhores práticas

Compliance streams

Eventos de compliance em tempo real

Referência da API

Documentação completa do endpoint

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Início rápido

Ações de compliance

Listar todos os jobs

Próximos passos

Guia de integração

Compliance streams

Referência da API

​Ações de compliance

​Listar todos os jobs

​Próximos passos

Guia de integração

Compliance streams

Referência da API

Ações de compliance

Listar todos os jobs

Próximos passos