Skip to main content

​
1) Set Your Base URL

Set your base URL to your deployment origin: 
export AD_DATASETS_BASE_URL="https://<your-deployment>.convex.site"

​
2) Set Your API Key

export AD_DATASETS_API_KEY="sk_..."

​
3) Validate Your Key

curl -s \
  -H "X-API-Key: $AD_DATASETS_API_KEY" \
  "$AD_DATASETS_BASE_URL/api/v2/me" | jq

​
4) List Ads (Fast Summary Payload)

curl -s \
  -H "X-API-Key: $AD_DATASETS_API_KEY" \
  "$AD_DATASETS_BASE_URL/api/v2/ads?limit=25" | jq

​
5) Follow Pagination

Responses include pagination.cursor and next_page_url when there is another page. 
next=$(curl -s \
  -H "X-API-Key: $AD_DATASETS_API_KEY" \
  "$AD_DATASETS_BASE_URL/api/v2/ads?limit=50" | jq -r .next_page_url)

curl -s -H "X-API-Key: $AD_DATASETS_API_KEY" "$next" | jq

​
6) Fetch One Ad (Full Object)

curl -s \
  -H "X-API-Key: $AD_DATASETS_API_KEY" \
  "$AD_DATASETS_BASE_URL/api/v2/ads/123456789" | jq

​
7) Search (GET)

curl -s \
  -H "X-API-Key: $AD_DATASETS_API_KEY" \
  "$AD_DATASETS_BASE_URL/api/v2/search?q=sleep&limit=10" | jq