X (Twitter) · JSON Structure

X Api Compliance Job Structure

ComplianceJob schema from X API v2

Type: object Properties: 9 Required: 8
Social MediaMicrobloggingReal-Time DataStreamingAdvertisingContent

ComplianceJob is a JSON Structure definition published by X (Twitter), describing 9 properties, of which 8 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

created_at download_expires_at download_url id name status type upload_expires_at upload_url

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twitter/refs/heads/main/json-structure/x-api-compliance-job-structure.json",
  "name": "ComplianceJob",
  "description": "ComplianceJob schema from X API v2",
  "type": "object",
  "properties": {
    "created_at": {
      "type": "datetime",
      "description": "Creation time of the compliance job.",
      "example": "2021-01-06T18:40:40.000Z"
    },
    "download_expires_at": {
      "type": "datetime",
      "description": "Expiration time of the download URL.",
      "example": "2021-01-06T18:40:40.000Z"
    },
    "download_url": {
      "type": "uri",
      "description": "URL from which the user will retrieve their compliance results."
    },
    "id": {
      "type": "string",
      "description": "Compliance Job ID.",
      "pattern": "^[0-9]{1,19}$",
      "example": "1372966999991541762"
    },
    "name": {
      "type": "string",
      "description": "User-provided name for a compliance job.",
      "maxLength": 64,
      "example": "my-job"
    },
    "status": {
      "type": "string",
      "description": "Status of a compliance job.",
      "enum": [
        "created",
        "in_progress",
        "failed",
        "complete",
        "expired"
      ]
    },
    "type": {
      "type": "string",
      "description": "Type of compliance job to list.",
      "enum": [
        "tweets",
        "users"
      ]
    },
    "upload_expires_at": {
      "type": "datetime",
      "description": "Expiration time of the upload URL.",
      "example": "2021-01-06T18:40:40.000Z"
    },
    "upload_url": {
      "type": "uri",
      "description": "URL to which the user will upload their Tweet or user IDs."
    }
  },
  "required": [
    "id",
    "type",
    "created_at",
    "upload_url",
    "download_url",
    "upload_expires_at",
    "download_expires_at",
    "status"
  ]
}