ad-campaigns
ad-campaigns

Poll Saphire Crawl Status

Poll the status of Saphire crawl / brand asset generation.

Returns:

  • When in progress: profile_id, status='pending', completed=false
  • When completed: profile_id, status='brand_assets_generated', completed=true
  • When failed: profile_id, status='failed', completed=true, error_message

Poll this endpoint until completed=true.

get/api/v1/ad-campaigns/crawl/status

Request

  • Base URL: https://api.trylapis.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.trylapis.com/api/v1/ad-campaigns/crawl/status
  • Auth: HTTP bearer

Query parameters

client_user_idinteger nullable

Client user ID to view data for

Headers

x-lapis-dev-tokenstring nullable
x-assume-user-idinteger nullable

Response

Successful Response

profile_idinteger nullable
statusstring required
completedboolean required
messagestring nullable
error_messagestring nullable
generation_stepstring nullable
generation_step_errorstring nullable

Changes

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