Skip to main content

​
Workflow A — “Show me a dashboard of leads by state”

1

Get the schema once

Cache GET /v1/datasets/leads/schema on your end. You’ll need it to build dropdowns.
2

Pull stats

GET /v1/datasets/leads/stats?group_by=state,tier — gives you counts by state and tier in one cheap call.
3

Render the dashboard

Loop through groups, draw a chart. Refresh the call every minute (response is cached anyway).

​
Workflow B — “Find homeowners aged 30-55 in TX, AZ, NV — first 500 results”

1

Call /search with limit=500

POST /v1/datasets/leads/search
{
  "filters": {
    "state":     { "in": ["TX","AZ","NV"] },
    "age":       { "between": [30, 55] },
    "homeowner": { "eq": "Y" },
    "dnc":       { "eq": "N" }
  },
  "limit": 500
}
2

Use the rows

The response’s rows array has up to 500 lead objects. total_estimate tells you how many more match.

​
Workflow C — “Export every California lead to CSV”

1

Kick off the export

POST /v1/exports
{
  "table":       "leads",
  "select":      ["*"],
  "filters":     { "state": { "eq": "CA" } },
  "format":      "csv",
  "compression": "gzip"
}
Save the returned export_id.
2

Poll until ready

Every 5 seconds: GET /v1/exports/{id}. Stop when status = completed.
3

Download

Curl the download_url and decompress. Done.