Skip to main content

​
ComplianceClient

The ComplianceClient provides methods for managing compliance jobs to retrieve historical data for tweets and users.

​
get_jobs

Retrieves a list of Compliance Jobs filtered by job type and optional status. 
response = client.compliance.get_jobs(
    type="tweets",
    status="complete",
    compliance_job_fields=["id", "type", "status", "created_at"]
)
​
type
str
required
Type of Compliance Job to list. Valid values: “tweets” or “users”.
​
status
str
Status of Compliance Job to list. Valid values: “created”, “in_progress”, “complete”, “failed”.
​
compliance_job_fields
List[str]
A comma separated list of ComplianceJob fields to display.
​
GetJobsResponse
object
Response containing list of compliance jobs.

​
create_jobs

Creates a new Compliance Job for the specified job type. 
from xdk.compliance.models import CreateJobsRequest

response = client.compliance.create_jobs(
    body=CreateJobsRequest(
        type="tweets",
        name="My Compliance Job"
    )
)
​
body
CreateJobsRequest
required
A request to create a new batch compliance job.
​
CreateJobsResponse
object
Response containing the created compliance job details.

​
get_jobs_by_id

Retrieves details of a specific Compliance Job by its ID. 
response = client.compliance.get_jobs_by_id(
    id="1234567890",
    compliance_job_fields=["id", "type", "status", "download_url"]
)
​
id
str
required
The ID of the Compliance Job to retrieve.
​
compliance_job_fields
List[str]
A comma separated list of ComplianceJob fields to display.
​
GetJobsByIdResponse
object
Response containing the compliance job details, including download URL when complete.

Build docs developers (and LLMs) love

Get started for freeTalk to us