Tracking

Update tracking settings for a creator

patch/v1/tracking/creators/{id}

Request

  • Base URL: https://api.virlo.ai
  • URL: https://api.virlo.ai/v1/tracking/creators/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

UUID of the tracked creator to update

Request body

status'active' | 'paused'
scrape_cadence'six_hours' | 'twelve_hours' | 'daily' | 'every_other_day' | 'weekly' | 'bi_weekly' | 'monthly'

How often to collect metrics and generate an AI report

Response

Updated creator

Example response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "platform": "tiktok",
    "platform_handle": "khaby.lame",
    "profile_url": "https://www.tiktok.com/@khaby.lame",
    "display_name": "Khabane lame",
    "avatar_url": "https://auth.virlo.ai/storage/v1/object/public/avatars/e9aa0e4c-b385-40a1-b829-9f72d07bda76.jpg",
    "bio": "If u wanna laugh u r in the right place",
    "is_verified": true,
    "status": "active",
    "scrape_cadence": "daily",
    "enrichment_status": "completed",
    "finalized": true,
    "pending_jobs": [
      {
        "type": "viral_analysis",
        "status": "processing",
        "job_id": "aud_01HXYZ",
        "poll_url": "/v1/orbit/orb_01HXYZ/analysis/latest",
        "result_path": "data.analysis_data",
        "webhook_event": "orbit.run.completed",
        "started_at": "2026-05-22T05:00:00.000Z",
        "retry_after_seconds": 15
      }
    ],
    "latest_followers": 162400000,
    "latest_following": 8200000,
    "latest_total_likes": 2400000000,
    "latest_total_views": 8455553979,
    "latest_total_videos": 1203,
    "last_scraped_at": "2026-03-23T14:00:00.000Z",
    "growth_rate": 0.0523,
    "followers_gained": 8500,
    "next_scrape_at": "2026-03-24T02:00:00.000Z",
    "profile_metadata": {
      "country": "US",
      "language": "en",
      "website": "https://example.com",
      "external_links": []
    },
    "created_at": "2026-03-20T10:30:00.000Z",
    "updated_at": "2026-03-23T14:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.