Documentation contents
Developers
API documentation
Launch your crawls, read every report and receive your projects’ events from your own tools. A versioned JSON REST API, whose quotas follow your plan.
Base URL
https://api.nessflow.com/v1
Get started
- Quickstart Create a token, make your first call to the NessFlow API and launch a crawl, in a few minutes.
- Authentication and scopes How an API token authenticates, what its scopes allow, and how the plan and the role add to them.
- API concepts Team, project, campaign, crawl, reports and modules, and how the API links them.
API reference
Every operation, its parameters, its responses and a call example in four languages.
- Account The token, its team, its plan and its consumption. 3 operations
- Projects Projects (sites followed over time) and their health scorecard. 6 operations
- Campaigns Reusable crawl configurations and their schedule. 5 operations
- Crawls Crawl runs and their results, issues and pages. 14 operations
- Recommendations AI recommendations, global and per page. 2 operations
- Exports PDF reports and Excel workbooks of a crawl, generated asynchronously. 3 operations
- Modules Modules outside the health score (rankings, Search Console, backlinks, security, logs). They carry trends, never a score. 10 operations
- Webhooks Signed outbound events (crawl finished, export ready, recommendations ready, signal detected). Managed by team owners and admins. 8 operations