Web Report Generator API. Generate a combined website audit report covering SEO, social metadata, performance, security, content, and crawlability signals. Send a JSON POST request and receive a structured JSON response. Pricing, quotas, authentication, and subscriptions are handled by Zyla API Hub.
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
The Report Generator endpoint returns a comprehensive website audit report that includes data on SEO, social metadata, performance metrics, security assessments, content quality, and crawlability signals.
Key fields in the response data typically include SEO score, performance metrics, security status, content analysis, social metadata details, and crawlability indicators, each providing insights into different aspects of the website's health.
The response data is structured in a JSON format, organized into distinct sections for each audit category, allowing users to easily navigate and extract relevant information for analysis.
Users can customize their requests by specifying parameters such as the target URL, audit categories to include, and any specific metrics they wish to focus on, enhancing the relevance of the generated report.
The data for the reports is sourced from various web analytics and SEO tools, ensuring a comprehensive analysis based on industry standards and best practices for website evaluation.
Typical use cases include website performance optimization, SEO strategy development, security assessments, and content improvement initiatives, helping businesses enhance their online presence and user experience.
Users can leverage the returned data to identify strengths and weaknesses in their website, prioritize areas for improvement, and track progress over time by comparing reports from different periods.
Data accuracy is maintained through regular updates and validation processes, ensuring that the information reflects the latest web standards and practices, thus providing reliable insights for users.
The Report Generator endpoint provides insights into various aspects of a website, including SEO performance, social media metadata, site speed and performance metrics, security vulnerabilities, content quality assessments, and crawlability signals, enabling a holistic view of the website's health.
Users can customize their requests by specifying parameters such as the target URL, selecting specific audit categories (e.g., SEO, performance), and defining particular metrics to focus on, allowing for tailored reports that meet individual needs.
Accepted parameter values include valid URLs for the target website, specific audit categories (like "SEO" or "security"), and metrics such as "performance score" or "crawlability score," which help refine the report's focus.
Specific data fields in the response include "SEO score" (indicating optimization level), "performance metrics" (showing load times), "security status" (highlighting vulnerabilities), and "crawlability indicators" (indicating how easily search engines can access the site).
Users should implement error handling in their applications to manage partial or empty results. This can include checking for specific fields in the response and providing fallback messages or alternative actions if critical data is missing.
Data accuracy is ensured through a combination of automated validation processes and periodic manual reviews, which check for consistency and relevance, ensuring that the insights provided reflect current web standards and practices.
The data covers a wide range of categories relevant to website performance and health, including global SEO practices, social media trends, and security standards, applicable to websites across various industries and regions.
Users can expect standard data patterns such as structured sections for each audit category, with numerical scores for performance and SEO, qualitative assessments for content, and binary indicators for security, facilitating easy interpretation and analysis.
To obtain your API key, you first need to sign in to your account and subscribe to the API you want to use. Once subscribed, go to your Profile, open the Subscription section, and select the specific API. Your API key will be available there and can be used to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
If you don’t cancel before the 7th day, your free trial will end automatically and your subscription will switch to a paid plan under the same plan you originally subscribed to, meaning you will be charged and gain access to the API calls included in that plan.
The free trial ends when you reach 50 API requests or after 7 days, whichever comes first.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost, so you can test our APIs without any commitment.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund
Service Level:
100%
Response Time:
1,351ms
Service Level:
100%
Response Time:
40ms
Service Level:
100%
Response Time:
1,403ms
Service Level:
100%
Response Time:
1,130ms
Service Level:
100%
Response Time:
50ms
Service Level:
100%
Response Time:
0ms
Service Level:
100%
Response Time:
3,864ms
Service Level:
100%
Response Time:
0ms
Service Level:
100%
Response Time:
73ms
Service Level:
100%
Response Time:
1,810ms