SEO

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/seo/audit' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "site_id": "<string(uuid)>", "url": "", "max_pages": 20 }'

{
  "audit_id": "…",
  "data": "…",
  "site_id": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/seo/audits' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "site_id": "str",
      "url": "str",
      "health_score": "int",
      "pages_crawled": "int",
      "total_issues": "int",
      "ssl_valid": "bool",
      "robots_found": "bool",
      "sitemap_found": "bool",
      "created_at": "str"
    },
    "...x2"
  ]
}

curl 'https://api.vxcloud.io/api/v1/salesshift/seo/audits/{audit_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "id": "str",
    "site_id": "str",
    "url": "str",
    "health_score": "int",
    "pages_crawled": "int",
    "total_issues": "int",
    "ssl_valid": "bool",
    "robots_found": "bool",
    "sitemap_found": "bool",
    "created_at": "str",
    "result": {
      "ssl": {
        "host": "...",
        "valid": "...",
        "issuer": "...",
        "subject": "...",
        "expires_at": "...",
        "days_to_expiry": "..."
      },
      "url": "str",
      "pages": [
        "...",
        "...x20"
      ],
      "domain": "str",
      "issues": [
        "...",
        "...x47"
      ],
      "sitemap": {
        "url": "...",
        "found": "...",
        "is_index": "...",
        "url_count": "..."
      },
      "success": "bool",
      "max_pages": "int",
      "robots_txt": {
        "url": "...",
        "found": "...",
        "status": "...",
        "allows_crawl": "...",
        "sitemap_urls": "..."
      },
      "performance": {
        "slowest": "...",
        "avg_load_ms": "...",
        "max_load_ms": "...",
        "pages_analyzed": "...",
        "slow_pages_count": "..."
      },
      "generated_at": "str",
      "health_score": "int",
      "issue_counts": {
        "info": "...",
        "errors": "...",
        "warnings": "..."
      },
      "total_issues": "int",
      "pages_crawled": "int"
    }
  }
}

curl 'https://api.vxcloud.io/api/v1/salesshift/seo/keywords' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "site_id": "str",
      "site_domain": "str",
      "keyword": "str",
      "country": "str",
      "device": "str",
      "current_rank": "null",
      "previous_rank": "null",
      "best_rank": "null",
      "delta": "null",
      "search_volume": "null",
      "difficulty": "null",
      "cpc": "null",
      "landing_url": "null",
      "last_checked_at": "null",
      "is_tracking": "bool",
      "history": [
        "<empty list>"
      ],
      "sparkline": [
        "<empty list>"
      ],
      "created_at": "str"
    },
    "...x4"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/seo/keywords' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "site_id": "<string(uuid)>", "keyword": "", "keywords": [ "<string>" ], "country": "us", "device": "desktop" }'

{
  "added": "…",
  "data": "…",
  "skipped": "…",
  "success": "…"
}

curl -X DELETE 'https://api.vxcloud.io/api/v1/salesshift/seo/keywords/{keyword_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "…"
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/seo/keywords/{keyword_id}/check' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "blocked": "…",
  "data": "…",
  "engine": "…",
  "error": "…",
  "results_parsed": "…",
  "success": "…"
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/seo/keywords/check-all' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "blocked": "…",
  "checked": "…",
  "declined": "…",
  "failed": "…",
  "improved": "…",
  "remaining": "…",
  "results": "…",
  "stopped_early": "…",
  "success": "…",
  "total": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/seo/overview' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "sites": "int",
    "keywords_tracked": "int",
    "keywords_ranked": "int",
    "avg_position": "float",
    "top_3": "int",
    "top_10": "int",
    "top_100": "int",
    "improved": "int",
    "declined": "int",
    "improved_30d": "int",
    "declined_30d": "int",
    "last_audit": {
      "id": "str",
      "score": "int",
      "issues": "int",
      "pages_crawled": "int",
      "url": "str",
      "at": "str"
    },
    "movers_up": [
      "<empty list>"
    ],
    "movers_down": [
      "<empty list>"
    ]
  }
}

curl 'https://api.vxcloud.io/api/v1/salesshift/seo/sites' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "domain": "str",
      "name": "str",
      "health_score": "int",
      "last_audit_at": "str",
      "keywords_count": "int",
      "created_at": "str"
    },
    "...x2"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/seo/sites' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "domain": "<string>", "name": "" }'

{
  "data": "…",
  "existing": "…",
  "success": "…"
}

curl -X DELETE 'https://api.vxcloud.io/api/v1/salesshift/seo/sites/{site_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "…"
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/seo/suggest' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "seed": "<string>", "country": "us" }'

{
  "error": "…",
  "seed": "…",
  "success": "…",
  "suggestions": "…"
}