Inicio rápido

Esta guía te acompaña en la creación de un batch compliance job para verificar el estado de compliance de Posts o usuarios.

Requisitos previosAntes de comenzar, necesitarás:

Una cuenta de desarrollador con una App aprobada
El Bearer Token de tu App

Crea un job

Crea un nuevo compliance job especificando el tipo (tweets o 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())

Respuesta:

{
  "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"
  }
}

Guarda upload_url y download_url para los siguientes pasos.

Prepara tu archivo de datos

Crea un archivo de texto con un ID por línea:

Guárdalo como ids.txt.

Sube tus datos

Sube el archivo a la upload_url proporcionada:

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

Verifica el estado del job

Consulta el estado del job hasta que se complete:

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

Estados del job:

Estado	Descripción
`created`	Job creado, esperando la subida
`in_progress`	Procesando datos
`complete`	Resultados listos para descargar
`failed`	El job falló
`expired`	El job expiró antes de completarse

Descarga los resultados

Cuando el estado sea complete, descarga desde download_url:

curl "DOWNLOAD_URL_FROM_RESPONSE" -o results.json

Formato del resultado (un objeto JSON por línea):

{"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"}

Solo los IDs con eventos de compliance aparecen en los resultados. Los IDs que no están en los resultados siguen siendo válidos.

Acciones de compliance

Eventos de compliance de Post

Acción	Razón	Descripción
`delete`	`deleted`	El Post fue eliminado
`delete`	`bounced`	El Post falló la verificación de compliance
`delete`	`protected`	La cuenta se volvió protegida
`delete`	`suspended`	La cuenta fue suspendida
`delete`	`scrub_geo`	Se eliminaron los datos de geolocalización

Eventos de compliance de usuario

Acción	Razón	Descripción
`delete`	`deleted`	La cuenta fue eliminada
`delete`	`suspended`	La cuenta fue suspendida
`delete`	`protected`	La cuenta se volvió protegida
`delete`	`deactivated`	La cuenta fue desactivada

Listar todos los jobs

Obtén todos los compliance jobs de tu App:

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

Próximos pasos

Guía de integración

Conceptos clave y buenas prácticas

Compliance streams

Eventos de compliance en tiempo real

Referencia de la API

Documentación completa del endpoint

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Inicio rápido

Acciones de compliance

Listar todos los jobs

Próximos pasos

Guía de integración

Compliance streams

Referencia de la API

​Acciones de compliance

​Listar todos los jobs

​Próximos pasos

Guía de integración

Compliance streams

Referencia de la API

Acciones de compliance

Listar todos los jobs

Próximos pasos