Batch Tweet compliance lookup

API reference contents

Returns a list of recent compliance jobs for Tweets.

Endpoint URL

https://api.twitter.com/2/tweets/compliance/jobs

Authentication and rate limits

Authentication methods supported by this endpoint	OAuth 2.0 Bearer token
Rate limit	15 requests per 15-minute window (app auth)

Learn more about rate limits.

Query parameters

Name	Type	Description
`start_time` Optional	date (ISO 8601)	The oldest UTC timestamp from which jobs will be provided by job creation time.
`start_time` Optional	date (ISO 8601)	The newest, most recent UTC timestamp from which jobs will be provided by job creation time.
`status` Optional	enum (`all`, `in_progress`, `failed`, `complete`, `expired`)	Allows to filter by job status. Only one filter can be specified per request. Default: `all`

Example requests

cURL
twurl
cURL (complete jobs in a specific time range)
twurl (complete jobs in a specific time range)

curl -X GET https://api.twitter.com/2/tweets/compliance/jobs -H "Authorization: Bearer $BEARER_TOKEN"

twurl -X GET --bearer /2/tweets/compliance/jobs

curl -X GET "https://api.twitter.com/2/tweets/compliance/jobs?status=complete&start_time=2020-09-01T00%3A00%3A00Z&end_time=2020-09-08T00%3A00%3A00Z" -H "Authorization: Bearer $BEARER_TOKEN"

twurl -X GET --bearer "/2/tweets/compliance/jobs?status=complete&start_time=2020-09-01T00%3A00%3A00Z&end_time=2020-09-08T00%3A00%3A00Z"

{
  "jobs": [
    {
      "job_id": "NIXh2p",
      "job_name": "Feline species research",
      "created_at": "2020-09-03T21:17:43.819+00:00",
      "download_url": "https://storage.googleapis.com/twitter-compliance/test_user_ids?X-Goog-Algorithm=\nGOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount\n.com%2F20181026%2Fus-central-1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18\n1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16\n9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849\n6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc\nc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058\n0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a\n66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823\na29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703\n2ea7abedc098d2eb14a7",
      "download_expires_at": "2020-06-16T11:17:32.819+00:00",
      "status": "complete"
    },
    {
      "job_id": "jU8rFK",
      "job_name": "Troglomyces twitteri",
      "download_url": "https://storage.googleapis.com/twitter-compliance/test_user_ids?X-Goog-Algorithm=\nGOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount\n.com%2F20181026%2Fus-central-1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18\n1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16\n9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849\n6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc\nc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058\n0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a\n66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823\na29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703\n2ea7abedc098d2eb14a7",
      "download_expires_at": "2020-09-04T20:04:41.819+00:00",
      "status": "complete"
    }
  ]
}

{
  "jobs": [
    {
      "job_id": "YIAh2p",
      "job_name": "My Compliance Job",
      "created_at": "2020-06-15T21:17:43.819+00:00",
      "download_url": "https://storage.googleapis.com/twitter-compliance/test_user_ids?X-Goog-Algorithm=\nGOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount\n.com%2F20181026%2Fus-central-1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18\n1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16\n9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849\n6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc\nc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058\n0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a\n66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823\na29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703\n2ea7abedc098d2eb14a7",
      "download_expires_at": "2020-06-16T21:17:43.819+00:00",
      "status": "complete"
    },
    {
      "job_id": "KU8RFj",
      "job_name": "My Other Compliance Job",
      "download_url": "https://storage.googleapis.com/twitter-compliance/test_user_ids?X-Goog-Algorithm=\nGOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount\n.com%2F20181026%2Fus-central-1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18\n1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16\n9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849\n6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc\nc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058\n0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a\n66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823\na29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703\n2ea7abedc098d2eb14a7",
      "download_expires_at": "2020-06-16T21:17:43.819+00:00",
      "status": "failed",
      "error": "Upload did not match required format"
    }
  ]
}

Response fields

Name	Type	Description
`job_id` Default	string	The unique identifier for this job.
`job_name`	string	The user defined job name. Only returned if specified when the job was created.
`download_url` Default	string	The predefined location where to download the results from the compliance job. This URL is already signed with an authentication key, so you will not need to pass any additional credential or header to authenticate the request.
`download_expires_at` Default	date (ISO 8601)	The date and time until which the download URL will be available (usually 7 days from the request time).
`status` Default	enum (`in_progress`, `failed`, `complete`, `expired`)	Current status of this job.
`estimated_completion`	date (ISO 8601)	Only returned when `jobs.status` is `in_progress`. The estimated time of completion for this job.
`error`	string	Only returned when `jobs.status` is `failed`. Specifies the reason why the job did not complete successfully.

Was this document helpful?

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?

This page is missing information.

The information was hard to follow or confusing.

There is inaccurate information.

There is a broken link or typo.

Specific Feedback