Kumquat API

Backend for the creative team’s platform

Health

• GET
  Health/health

Webhooks

• POST
  Clerk Webhook/webhooks/clerk

Analytics

• GET
  Creative Metrics/api/v1/analytics/creatives
• GET
  Creative Daily Metrics/api/v1/analytics/creatives/daily
• GET
  Creative Analytics Schema/api/v1/analytics/creatives/schema

Generated Assets

• GET
  List Assets/api/v1/assets
• GET
  List Asset Tags/api/v1/assets/tags
• GET
  List Asset Authors/api/v1/assets/authors
• PATCH
  Set Asset Tags/api/v1/assets/{key}/tags
• GET
  Get Asset/api/v1/assets/{key}

Web Funnels

• GET
  Web Funnel Metrics/api/v1/web-funnels
• GET
  Web Funnel Schema/api/v1/web-funnels/schema

Audit Log

• GET
  List Audit Logs/api/v1/audit-logs
• GET
  Entity History/api/v1/audit-logs/{entity_type}/{entity_id}/history

Comments

• GET
  List Comments/api/v1/tasks/{task_id}/comments
• POST
  Create Comment/api/v1/tasks/{task_id}/comments
• DELETE
  Delete Comment/api/v1/tasks/{task_id}/comments/{comment_id}
• PATCH
  Update Comment/api/v1/tasks/{task_id}/comments/{comment_id}
• PUT
  Add Reaction/api/v1/tasks/{task_id}/comments/{comment_id}/reactions/{emoji}
• DELETE
  Remove Reaction/api/v1/tasks/{task_id}/comments/{comment_id}/reactions/{emoji}

Creatives

• GET
  Creative Schemas/api/v1/creatives/schema
• GET
  List Creatives/api/v1/creatives
• GET
  Creatives Gallery/api/v1/creatives/gallery
• GET
  Creative Notes Cloud/api/v1/creatives/notes-cloud
• GET
  Get Creative By Name/api/v1/creatives/by-name/{name}
• GET
  Creative Options/api/v1/creatives/options
• GET
  Creative Variants/api/v1/creatives/variants
• GET
  Get Creative/api/v1/creatives/{creative_id}
• DELETE
  Delete Creative/api/v1/creatives/{creative_id}
• PATCH
  Update Creative/api/v1/creatives/{creative_id}
• POST
  Add Creative Idea/api/v1/creatives/{creative_id}/ideas
• PATCH
  Update Creative Idea/api/v1/creatives/{creative_id}/ideas/{idea_id}

Creative Tags

• GET
  List Tags/api/v1/tags
• POST
  Propose Tag/api/v1/tags
• PATCH
  Set Tag Status/api/v1/tags/{slug}/status
• PATCH
  Set Tag Label/api/v1/tags/{slug}/label
• DELETE
  Delete Tag/api/v1/tags/{slug}

Exports

• POST
  Export Creatives/api/v1/exports/creatives
• POST
  Export Tasks/api/v1/exports/tasks

Google Drive Files

• GET
  Get Gdrive File/api/v1/gdrive-files
• GET
  List Folder Files/api/v1/gdrive-files/folders/{folder_id}

Inbox

• GET
  List Inbox/api/v1/inbox
• POST
  Mark Read/api/v1/inbox/read
• POST
  Mark Unread/api/v1/inbox/unread
• POST
  Mark All Read/api/v1/inbox/read-all
• GET
  Get Preferences/api/v1/inbox/preferences
• PUT
  Set Preferences/api/v1/inbox/preferences

Frame Analysis

• GET
  List Frame Analyses/api/v1/frame-analyses
• POST
  Create Frame Analysis/api/v1/frame-analyses
• GET
  List Frame Analyses Expanded/api/v1/frame-analyses/expanded
• GET
  Creative Trend/api/v1/frame-analyses/creative-trend
• GET
  Get Frame Analysis/api/v1/frame-analyses/{run_id}
• DELETE
  Delete Frame Analysis/api/v1/frame-analyses/{run_id}
• POST
  Preview Frame Analysis/api/v1/frame-analyses/preview

Integrations

• GET
  Get Packs/api/v1/integrations/creative-tests/packs
• POST
  Lookup Creatives/api/v1/integrations/creative-tests/creatives/lookup
• POST
  Mark Creatives Launched/api/v1/integrations/creative-tests/creatives/launched
• POST
  Mark Packs Launched/api/v1/integrations/creative-tests/packs/launched

Tasks

• GET
  Tasks Board/api/v1/tasks/board
• GET
  Tasks Board Columns/api/v1/tasks/board/columns
• GET
  Tasks Board Capacity/api/v1/tasks/board/capacity
• GET
  Deleted Tasks/api/v1/tasks/deleted
• GET
  Task Schemas/api/v1/tasks/schema
• GET
  Task Rollups/api/v1/tasks/rollups
• GET
  Task Options/api/v1/tasks/options
• POST
  Create Task/api/v1/tasks
• GET
  Get Task/api/v1/tasks/{task_id}
• DELETE
  Delete Task/api/v1/tasks/{task_id}
• PATCH
  Update Task/api/v1/tasks/{task_id}
• GET
  Task History/api/v1/tasks/{task_id}/history
• POST
  Restore Task/api/v1/tasks/{task_id}/restore
• PATCH
  Transition Task Status/api/v1/tasks/{task_id}/status

Task Templates

• GET
  List Task Templates/api/v1/task-templates
• POST
  Create Task Template/api/v1/task-templates
• DELETE
  Delete Task Template/api/v1/task-templates/{template_id}
• PATCH
  Update Task Template/api/v1/task-templates/{template_id}

Products

• GET
  List Products/api/v1/products
• POST
  Create Product/api/v1/products
• GET
  Get Product/api/v1/products/{product_id}
• DELETE
  Delete Product/api/v1/products/{product_id}
• PATCH
  Update Product/api/v1/products/{product_id}

Uploads

• POST
  Upload File/api/v1/uploads

Users

• GET
  List Users/api/v1/users
• POST
  Create User/api/v1/users
• GET
  User Options/api/v1/users/options
• DELETE
  Delete User/api/v1/users/{user_id}
• PATCH
  Update User/api/v1/users/{user_id}

Node Graphs

• GET
  List Node Specs/api/v1/nodes
• GET
  List Graphs/api/v1/graphs
• POST
  Create Graph/api/v1/graphs
• POST
  Create Graph From Template/api/v1/graphs/from-template
• POST
  Add Graph To Task/api/v1/graphs/{graph_id}/for-task
• GET
  Graph Spend/api/v1/graphs/spend
• GET
  Get Graph/api/v1/graphs/{graph_id}
• DELETE
  Delete Graph/api/v1/graphs/{graph_id}
• PATCH
  Update Graph/api/v1/graphs/{graph_id}
• DELETE
  Unlink Graph Task/api/v1/graphs/{graph_id}/tasks/{task_id}
• POST
  Duplicate Graph/api/v1/graphs/{graph_id}/duplicate
• POST
  Publish Template/api/v1/graphs/{graph_id}/template
• GET
  List Runs/api/v1/graphs/{graph_id}/runs
• POST
  Start Run/api/v1/graphs/{graph_id}/runs
• GET
  List All Runs/api/v1/runs
• GET
  Get Run Spend/api/v1/runs/{run_id}/spend
• GET
  Get Runs Spend/api/v1/runs/spend
• GET
  Get Run/api/v1/runs/{run_id}
• DELETE
  Delete Run/api/v1/runs/{run_id}
• PATCH
  Update Run/api/v1/runs/{run_id}
• POST
  Restart Run/api/v1/runs/{run_id}/start
• POST
  Fork Run/api/v1/runs/{run_id}/fork
• POST
  Restore Run/api/v1/runs/{run_id}/restore
• POST
  Duplicate Run/api/v1/runs/{run_id}/duplicate
• POST
  Cancel Run/api/v1/runs/{run_id}/cancel
• POST
  Resume Run/api/v1/runs/{run_id}/resume
• GET
  Graph History/api/v1/graphs/{graph_id}/history
• GET
  Graph History At/api/v1/graphs/{graph_id}/history/at
• POST
  Restore Graph History/api/v1/graphs/{graph_id}/history/restore
• GET
  Run History/api/v1/runs/{run_id}/history
• GET
  Run History At/api/v1/runs/{run_id}/history/at
• GET
  Run As Of/api/v1/runs/{run_id}/at
• POST
  Restore Run History/api/v1/runs/{run_id}/history/restore

Events

• GET
  Live Events/api/v1/events