archives

Knowledge-base & Docs

Welcome to SerpWatch, the feature-rich SEO rank tracker priced for everyone! SerpWatch documentation contains everything you need to get the most out of SerpWatch: how-to’s, FAQs, and instruction videos.  Here, you will find step-by-step guides on how to add your first project, create your custom billing plan, integrate Google Analytics and Search Console, customize Notifications, use […]

Continue Reading  

This overview covers the base URL, authentication, rate limits, pagination, and error formats for the Reporting API. Base URL All Reporting API requests should be made to: Copy https://v2.serpwatch.io/api Endpoints are under the /reporting namespace. Authentication All API requests require a Bearer token. Include your API key in the Authorization header: Copy Authorization: Bearer YOUR_API_KEY […]

Continue Reading  

This section provides detailed API references for Reporting API endpoints. Endpoints Sections Projects – List projects and fetch project stats. Keywords – List keywords, keyword detail, and keyword history.

Continue Reading  

This section covers project endpoints in the Reporting API. GET /reporting/projects List all projects accessible to the authenticated user. Parameters Name Type Description per_page integer Items per page (default: 25). cursor string Pagination cursor from links.next or meta.next_cursor. fields string Comma-separated list of fields to include (e.g., project_id,name). Sample Response Copy { “data”: [ { […]

Continue Reading  

This section covers keyword endpoints in the Reporting API. GET /reporting/projects/{id}/keywords List keywords for a project with filtering, searching, and sorting. Parameters Name Type Description search string Search keywords by name. sort string Sort field: name, current_position, movement, status, best_position. order string Sort order: asc or desc (default: asc). location string Filter by location. device […]

Continue Reading  

Task Lifecycle The SerpWatch API uses an asynchronous task-based architecture for most operations. Understanding the task lifecycle helps you build robust integrations. Overview When you submit a request to an async endpoint (like SERP crawling or keyword research), the API creates a task and returns immediately with a task ID. The task is then processed […]

Continue Reading  

Error Codes This page documents all error responses returned by the SerpWatch API, including HTTP status codes, error formats, and troubleshooting guidance. Error Response Format All error responses include a JSON body with details about the error. The format varies slightly depending on the error type. Standard Error Copy { “detail”: “Error message describing what […]

Continue Reading  

Batch Processing Process hundreds or thousands of keywords efficiently using the batch API endpoints. Batch requests reduce API overhead and are the recommended approach for large-scale operations. Overview The batch endpoint allows you to submit multiple crawl requests in a single API call. Each request in the batch is processed independently, and results are delivered […]

Continue Reading  

API Integration documentation for SerpWatch.

Continue Reading  

Keyword Data Reference Get search volume, cost-per-click (CPC), competition metrics, and trend data for any keyword across different locations and languages. Endpoints Overview Endpoint Method Description /api/v1/keyword-sv POST Create keyword search volume task (async) /api/v1/keyword-sv/{task_id} GET Retrieve task results Create Search Volume Task POST /api/v1/keyword-sv Create a task to retrieve search volume metrics for one […]

Continue Reading