GThree Developer Docs

Returns Share of Model percentages broken down by model and query type. Pass a competitorDomain for head-to-head compare mode; omit it for solo mode.

{
  "brandDomain":      "example.com",
  "competitorDomain": "competitor.com"  // optional — omit for solo mode
}

{
  "mode": "compare",
  "results": {
    "overall":      { "brand": 62, "competitor": 38 },
    "byModel":      [{ "name": "GPT-4o", "model": "gpt-4o", "brand": 70, "competitor": 30 }],
    "byQueryType":  { "product-research": { "brand": 65, "competitor": 35, "tests": 8 } }
  },
  "summary": {
    "headline":       "example.com is mentioned more often...",
    "gap":            24,
    "modelInsight":   "...",
    "typeInsight":    "...",
    "recommendation": "..."
  }
}

curl -X POST https://gthree.agency/api/benchmark \
  -H 'Content-Type: application/json' \
  -d '{"brandDomain":"example.com","competitorDomain":"competitor.com"}'

Public cron-triggered endpoint. Pulls up to 20 due emails and dispatches them. Idempotent — safe to call on any schedule (GThree runs it every 10 minutes).

{ "processed": 12, "errors": 0 }

curl -X POST https://gthree.agency/api/nurture/send \
  -H 'Content-Type: application/json'

One-click unsubscribe. The token is the base64-encoded prospect email; id is the nurture row id. Cancels all pending emails for that prospect.

?id=123&token=amFtZXNAZXhhbXBsZS5jb20=

curl 'https://gthree.agency/api/nurture/unsubscribe?id=123&token=amFtZXNAZXhhbXBsZS5jb20='

Validates the shop domain, generates an OAuth state token, and 302s to Shopify's authorize URL with scopes read_products,read_product_listings,read_metaobjects.

curl -i 'https://gthree.agency/shopify/connect?shop=acme.myshopify.com'

Exchanges the authorization code for an access token, saves the connection, runs the catalog audit, and 302s to /shopify/audit/:id.

Renders the audit HTML page (total products, products with gaps, top gap categories, per-product findings).

Captures a demo-page submission with full UTM attribution. Generates a visitor id, looks up the matching marketing touchpoint, and persists the conversion.

{
  "name":         "Jane Doe",
  "email":        "jane@example.com",
  "store_url":    "https://example.com",
  "utm_source":   "linkedin",
  "utm_medium":   "cpc",
  "utm_campaign": "spring-launch",
  "utm_content":  "hero-cta",
  "utm_term":     "geo-agency"
}

{ "success": true, "conversion_id": 482 }

curl -X POST https://gthree.agency/api/demo-conversion \
  -H 'Content-Type: application/json' \
  -d '{"name":"Jane Doe","email":"jane@example.com","store_url":"https://example.com"}'

Returns the list of active marketing touchpoints (UTM templates). Each touchpoint has base_url, the five UTM params, and a type (email, paid_search, etc.).

Admin only. Bulk-enrolls outbound contacts into the nurture drip. Skips contacts already on a sequence. See the Authentication section for the bearer token.

{
  "contacts": [
    { "name": "Jane", "email": "jane@example.com", "storeUrl": "example.com", "somScore": 42, "category": "skincare" }
  ]
}

{ "enrolled": 1, "skipped": 0, "errors": 0, "detail": [{ "email": "jane@example.com", "result": "enrolled" }] }

All endpoints under /api/admin/* require this header. The token must match the server's ADMIN_SECRET env var. Missing or mismatched tokens return 401 Unauthorized.

curl -X POST https://gthree.agency/api/admin/outbound/enroll \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $ADMIN_SECRET' \
  -d '{"contacts":[{"name":"Jane","email":"jane@example.com"}]}'

Merchants complete OAuth at Shopify. GThree exchanges the authorization code server-side using SHOPIFY_CLIENT_ID + SHOPIFY_CLIENT_SECRET. No user-facing API key is exposed.