DataForSEO · Schema
DataForSEO Appendix API Schemas
SEOSERPKeywordsBacklinksDomain AnalyticsOn-Page SEOCompetitor ResearchSearch EnginesContent AnalysisE-CommerceApp StoreBusiness DataAI OptimizationSocial Media
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DataForSEO Appendix API Schemas",
"definitions": {
"AppendixStatusResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixStatusTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"BaseResponseInfo": {
"properties": {
"version": {
"type": "string",
"description": "the current version of the API",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "general status code\nyou can find the full list of the response codes here",
"nullable": true
},
"status_message": {
"type": "string",
"description": "general informational message\nyou can find the full list of general informational messages here",
"nullable": true
},
"time": {
"type": "string",
"description": "total execution time, seconds",
"nullable": true
},
"cost": {
"type": "number",
"description": "total tasks cost, USD",
"format": "double",
"nullable": true
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array",
"format": "int64",
"nullable": true
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64",
"nullable": true
}
}
},
"AppendixStatusTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixStatusResultInfo"
}
],
"nullable": true
},
"description": "array of results",
"nullable": true
}
}
}
]
},
"BaseResponseTaskInfo": {
"properties": {
"id": {
"type": "string",
"description": "task identifier\nunique task identifier in our system in the UUID format",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here",
"nullable": true
},
"status_message": {
"type": "string",
"description": "informational message of the task\nyou can find the full list of general informational messages here",
"nullable": true
},
"time": {
"type": "string",
"description": "execution time, seconds",
"nullable": true
},
"cost": {
"type": "number",
"description": "total tasks cost, USD",
"format": "double",
"nullable": true
},
"result_count": {
"type": "integer",
"description": "number of elements in the result array",
"format": "int64",
"nullable": true
},
"path": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "URL path",
"nullable": true
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object",
"nullable": true
},
"description": "contains the same parameters that you specified in the POST request",
"nullable": true
}
}
},
"AppendixStatusResultInfo": {
"type": "object",
"properties": {
"api": {
"type": "string",
"description": "name of the API\nthe list of APIs:\nserp\nkeywords_data\nappendix\ndataforseo_labs\ndomain_analytics\nmerchant\non_page\nbusiness_data\nbacklinks\napp_data\ncontent_analysis\ncontent_generation",
"nullable": true
},
"status": {
"type": "string",
"description": "current status\nyou can find all information about the statuses of our endpoints for the last 60 days here\nthe list of possible current statuses:\nmajor_outage\npartial_outage\nlong_response_time\nlong_execution_time\nwebhook_delay\nsend_delay",
"nullable": true
},
"endpoints": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixStatusEndpointsInfo"
}
],
"nullable": true
},
"description": "array of objects that contain status information for API endpoints",
"nullable": true
}
}
},
"AppendixStatusEndpointsInfo": {
"type": "object",
"properties": {
"endpoint": {
"type": "string",
"description": "name of the endpoint\nthe list of possible endpoints:\ntask_get\ntask_post\nlive\npostback/pingback",
"nullable": true
},
"status": {
"type": "string",
"description": "current status\nyou can find all information about your API statuses for the last 60 days here\nthe list of possible current statuses:\nmajor_outage\npartial_outage\nlong_response_time\nlong_execution_time\nwebhook_delay\nsend_delay",
"nullable": true
}
}
},
"AppendixWebhookResendResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixWebhookResendTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"AppendixWebhookResendTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "object",
"description": "array of results\nthe value of this array is always null;\nyou can get the results by the preferred method of results delivery (pingback or postback) you specified when setting a task",
"nullable": true
}
}
}
]
},
"AppendixUserDataResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixUserDataTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"AppendixUserDataTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixUserDataResultInfo"
}
],
"nullable": true
},
"description": "array of results",
"nullable": true
}
}
}
]
},
"AppendixUserDataResultInfo": {
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "your login",
"nullable": true
},
"timezone": {
"type": "string",
"description": "your time zone\ncan be set in your profile settings",
"nullable": true
},
"rates": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixRatesData"
}
],
"description": "your API rates",
"nullable": true
},
"money": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixMoneyData"
}
],
"description": "section of your spending, USD",
"nullable": true
},
"price": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixPriceData"
}
],
"description": "pricing",
"nullable": true
},
"backlinks_subscription_expiry_date": {
"type": "string",
"description": "expiry date of the backlinks api subscription\ndate and time when the current subscription to Backlinks API expires;\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2025-06-15 12:57:46 +00:00\nNote: if there is no active subscription to Backlinks API, the value equals null",
"nullable": true
},
"llm_mentions_subscription_expiry_date": {
"type": "string",
"description": "expiry date of the llm mentions api subscription\ndate and time when the current subscription to LLM Mentions API expires;\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2026-02-28 14:01:38 +00:00\nNote: if there is no active subscription to LLM Mentions API, the value equals null",
"nullable": true
}
}
},
"AppendixRatesData": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixLimitsRatesData"
}
],
"description": "rate limits for API calls per a certain period of time",
"nullable": true
},
"statistics": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixStatisticsDataInfo"
}
],
"description": "statisctics for API calls",
"nullable": true
}
}
},
"AppendixLimitsRatesData": {
"type": "object",
"properties": {
"day": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixDayLimitsRatesData"
}
],
"nullable": true
},
"minute": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixDataInfo"
}
],
"nullable": true
}
}
},
"AppendixDataInfo": {
"type": "object",
"properties": {
"serp": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixSerpDataInfo"
}
],
"nullable": true
},
"total": {
"type": "number",
"description": "total amount of money deposited to your account",
"format": "double",
"nullable": true
},
"total_serp": {
"type": "number",
"format": "double",
"nullable": true
},
"keywords_data": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixKeywordsDataDataInfo"
}
],
"nullable": true
},
"total_keywords_data": {
"type": "number",
"format": "double",
"nullable": true
},
"appendix": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixAppendixDataInfo"
}
],
"nullable": true
},
"total_appendix": {
"type": "number",
"format": "double",
"nullable": true
},
"dataforseo_labs": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixDataforseoLabsLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_dataforseo_labs": {
"type": "number",
"format": "double",
"nullable": true
},
"domain_analytics": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixDomainAnalyticsLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_domain_analytics": {
"type": "number",
"format": "double",
"nullable": true
},
"merchant": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixMerchantLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_merchant": {
"type": "number",
"format": "double",
"nullable": true
},
"on_page": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixOnPageLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_on_page": {
"type": "number",
"format": "double",
"nullable": true
},
"business_data": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixBusinessDataLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_business_data": {
"type": "number",
"format": "double",
"nullable": true
},
"backlinks": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixBacklinksLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_backlinks": {
"type": "number",
"format": "double",
"nullable": true
},
"app_data": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixAppDataLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_app_data": {
"type": "number",
"format": "double",
"nullable": true
},
"content_analysis": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixContentAnalysisLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_content_analysis": {
"type": "number",
"format": "double",
"nullable": true
},
"content_generation": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixContentGenerationLimitsRatesDataInfo"
}
],
"nullable": true
},
"total_content_generation": {
"type": "number",
"format": "double",
"nullable": true
},
"total_traffic_analytics": {
"type": "number",
"format": "double",
"nullable": true
},
"traffic_analytics": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixSerpDaysRatesDataInfo"
}
],
"nullable": true
},
"total_reviews": {
"type": "number",
"format": "double",
"nullable": true
},
"reviews": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixSerpDaysRatesDataInfo"
}
],
"nullable": true
},
"total_social": {
"type": "number",
"format": "double",
"nullable": true
},
"social": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixSerpDaysRatesDataInfo"
}
],
"nullable": true
}
}
},
"AppendixDataforseoLabsLimitsRatesDataInfo": {
"type": "object",
"properties": {
"locations_and_languages": {
"type": "number",
"format": "double",
"nullable": true
},
"categories": {
"type": "number",
"format": "double",
"nullable": true
},
"errors": {
"type": "number",
"format": "double",
"nullable": true
},
"product_competitors": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"product_keyword_intersections": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"product_rank_overview": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"ranked_keywords": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"serp_competitors": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"subdomains": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"relevant_pages": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"competitors_domain": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"related_keywords": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"domain_rank_overview": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"domain_intersection": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"page_intersection": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"bulk_traffic_estimation": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"bulk_keyword_difficulty": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"bulk_search_volume": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"keywords_for_site": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"keyword_suggestions": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"keyword_ideas": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"historical_search_volume": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"categories_for_domain": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"domain_metrics_by_categories": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"top_searches": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"domain_whois_overview": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"historical_rank_overview": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"keywords_for_categories": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"historical_serps": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"app_competitors": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"keywords_for_app": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"app_intersection": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"bulk_app_metrics": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"search_intent": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"historical_bulk_traffic_estimation": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"categories_for_keywords": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"keyword_overview": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"historical_keyword_data": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
}
}
},
"AppendixInfo": {
"type": "object",
"properties": {
"task_post": {
"type": "number",
"format": "double"
},
"task_get": {
"type": "number",
"format": "double"
},
"tasks_ready": {
"type": "number",
"format": "double"
},
"live": {
"type": "number",
"format": "double"
}
}
},
"AppendixSerpDaysRatesDataInfo": {
"type": "object",
"properties": {
"task_post": {
"type": "number",
"format": "double",
"nullable": true
},
"task_get": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixFunctionTypeInfo"
}
],
"nullable": true
},
"tasks_ready": {
"type": "number",
"format": "double",
"nullable": true
},
"locations": {
"type": "number",
"format": "double",
"nullable": true
},
"languages": {
"type": "number",
"format": "double",
"nullable": true
},
"live": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixFunctionTypeInfo"
}
],
"properties": {
"regular": {
"type": "number",
"format": "double"
},
"advanced": {
"type": "number",
"format": "double"
},
"html": {
"type": "number",
"format": "double"
}
},
"nullable": true
},
"errors": {
"type": "number",
"format": "double",
"nullable": true
},
"tasks_fixed": {
"type": "number",
"format": "double",
"nullable": true
},
"jobs": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixJobsSerpLimitsRatesDataInfo"
}
],
"nullable": true
},
"screenshot": {
"type": "number",
"format": "double",
"nullable": true
}
}
},
"AppendixFunctionTypeInfo": {
"type": "object",
"properties": {
"regular": {
"type": "number",
"format": "double",
"nullable": true
},
"advanced": {
"type": "number",
"format": "double",
"nullable": true
},
"html": {
"type": "number",
"format": "double",
"nullable": true
}
}
},
"AppendixJobsSerpLimitsRatesDataInfo": {
"type": "object",
"properties": {
"task_post": {
"type": "number",
"format": "double",
"nullable": true
}
}
},
"AppendixContentGenerationLimitsRatesDataInfo": {
"type": "object",
"properties": {
"generate": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"generate_meta_tags": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"generate_text": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"paraphrase": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"check_grammar": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixContentGenerationDayLimitsRatesDataInfo"
}
],
"nullable": true
},
"text_summary": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixContentGenerationDayLimitsRatesDataInfo"
}
],
"nullable": true
},
"generate_sub_topics": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
}
}
},
"AppendixContentGenerationDayLimitsRatesDataInfo": {
"type": "object",
"properties": {
"live": {
"type": "number",
"format": "double",
"nullable": true
},
"languages": {
"type": "number",
"format": "double",
"nullable": true
}
}
},
"AppendixDomainAnalyticsLimitsRatesDataInfo": {
"type": "object",
"properties": {
"tasks_ready": {
"type": "number",
"format": "double",
"nullable": true
},
"errors": {
"type": "number",
"format": "double",
"nullable": true
},
"whois": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixWhoisDomainAnalyticsLimitsRatesDataInfo"
}
],
"nullable": true
},
"technologies": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixTechnologiesDomainAnalyticsLimitsRatesDataInfo"
}
],
"nullable": true
}
}
},
"AppendixTechnologiesDomainAnalyticsLimitsRatesDataInfo": {
"type": "object",
"properties": {
"domain_technologies": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"domains_by_technology": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/AppendixInfo"
}
],
"nullable": true
},
"languages": {
"type": "number",
"format": "double",
"nullable": true
},
"locations": {
"type": "number",
"format": "double",
"nullable": true
},
"
# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dataforseo/refs/heads/main/json-schema/dataforseo-appendix-schema.json