{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:botify/get-project-analyses":{"get":{"operationId":"analytics_botify_get_project_analyses","summary":"List all analyses for a project","description":"GET /analyses/{username}/{project_slug}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-analysis-summary":{"get":{"operationId":"analytics_botify_get_analysis_summary","summary":"Get an Analysis detail","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-crawl-statistics":{"get":{"operationId":"analytics_botify_get_crawl_statistics","summary":"Return global statistics for an analysis","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-crawl-statistics-by-frequency":{"get":{"operationId":"analytics_botify_get_crawl_statistics_by_frequency","summary":"Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min)","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"limit","in":"query","required":false,"description":"max number of elements to retrieve","schema":{"type":"integer","description":"max number of elements to retrieve"}},{"name":"frequency","in":"query","required":true,"description":"Aggregation frequency","schema":{"type":"string","enum":["1mn","5mn","60mn"],"description":"Aggregation frequency"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-crawl-statistics-urls":{"get":{"operationId":"analytics_botify_get_crawl_statistics_urls","summary":"Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"list_type","in":"query","required":true,"description":"URLs list type (crawled URLs or error URLs)","schema":{"type":"string","enum":["crawled","errors"],"description":"URLs list type (crawled URLs or error URLs)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-ganalytics-orphan-urls":{"get":{"operationId":"analytics_botify_get_ganalytics_orphan_urls","summary":"List of Orphan URLs","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"medium","in":"query","required":true,"description":"Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)","schema":{"type":"string","enum":["organic","social"],"description":"Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)"}},{"name":"source","in":"query","required":true,"description":"Traffic source, value: name of the search engine or social network","schema":{"type":"string","enum":["all","aol","ask","baidu","bing","facebook","google","google+","linkedin","naver","pinterest","reddit","tumblr","twitter","yahoo","yandex"],"description":"Traffic source, value: name of the search engine or social network"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-links-percentiles":{"get":{"operationId":"analytics_botify_get_links_percentiles","summary":"Get inlinks percentiles","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-page-rank-lost":{"get":{"operationId":"analytics_botify_get_page_rank_lost","summary":"Lost pagerank","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-sitemaps-report":{"get":{"operationId":"analytics_botify_get_sitemaps_report","summary":"Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-sitemaps-samples-out-of-config":{"get":{"operationId":"analytics_botify_get_sitemaps_samples_out_of_config","summary":"Sample list of URLs which were found in your sitemaps but outside of the","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-sitemaps-samples-sitemaps-only":{"get":{"operationId":"analytics_botify_get_sitemaps_samples_sitemaps_only","summary":"Sample list of URLs which were found in your sitemaps, within the project","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-links-top-domains":{"get":{"operationId":"analytics_botify_get_links_top_domains","summary":"Top domains","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-links-top-subdomains":{"get":{"operationId":"analytics_botify_get_links_top_subdomains","summary":"Top subddomains","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-urls":{"post":{"operationId":"analytics_botify_get_urls","summary":"Executes a query and returns a paginated response","description":"POST /analyses/{username}/{project_slug}/{analysis_slug}/urls","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project_slug","analysis_slug"],"properties":{"username":{"type":"string","description":"User's identifier"},"project_slug":{"type":"string","description":"Project's identifier"},"analysis_slug":{"type":"string","description":"Analysis' identifier"},"area":{"type":"string","enum":["current","disappeared","new","search_engines_orphans"],"default":"current","description":"Analysis context to execute the query"},"page":{"type":"integer","description":"Page Number"},"size":{"type":"integer","description":"Page Size"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-urls-aggs":{"post":{"operationId":"analytics_botify_get_urls_aggs","summary":"Query aggregator","description":"POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project_slug","analysis_slug"],"properties":{"username":{"type":"string","description":"User's identifier"},"project_slug":{"type":"string","description":"Project's identifier"},"analysis_slug":{"type":"string","description":"Analysis' identifier"},"area":{"type":"string","enum":["current","disappeared","new","search_engines_orphans"],"default":"current"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-urls-datamodel":{"get":{"operationId":"analytics_botify_get_urls_datamodel","summary":"Gets an Analysis datamodel","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"area","in":"query","required":false,"schema":{"type":"string","enum":["current","disappeared","new","search_engines_orphans"],"default":"current"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-urls-exports":{"get":{"operationId":"analytics_botify_get_urls_exports","summary":"A list of the CSV Exports requests and their current status","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/export","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/create-urls-export":{"post":{"operationId":"analytics_botify_create_urls_export","summary":"Creates a new UrlExport object and starts a task that will export the results into a csv","description":"POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/export","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project_slug","analysis_slug"],"properties":{"username":{"type":"string","description":"User's identifier"},"project_slug":{"type":"string","description":"Project's identifier"},"analysis_slug":{"type":"string","description":"Analysis' identifier"},"area":{"type":"string","enum":["current","disappeared","new","search_engines_orphans"],"default":"current"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-urls-export-status":{"get":{"operationId":"analytics_botify_get_urls_export_status","summary":"Checks the status of an CSVUrlExportJob object","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"url_export_id","in":"query","required":true,"description":"Url Export ID","schema":{"type":"string","description":"Url Export ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-urls-suggested-filters":{"post":{"operationId":"analytics_botify_get_urls_suggested_filters","summary":"Return most frequent segments (= suggested patterns in the previous version)","description":"POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/suggested_filters","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project_slug","analysis_slug"],"properties":{"username":{"type":"string","description":"User's identifier"},"project_slug":{"type":"string","description":"Project's identifier"},"analysis_slug":{"type":"string","description":"Analysis' identifier"},"area":{"type":"string","enum":["current","new"],"default":"current"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-url-detail":{"get":{"operationId":"analytics_botify_get_url_detail","summary":"Gets the detail of an URL for an analysis","description":"GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"analysis_slug","in":"query","required":true,"description":"Analysis' identifier","schema":{"type":"string","description":"Analysis' identifier"}},{"name":"url","in":"query","required":true,"description":"(Urlencoded) Searched URL","schema":{"type":"string","description":"(Urlencoded) Searched URL"}},{"name":"fields","in":"query","required":false,"description":"comma separated list of fields to return (c.f. URLs Datamodel)","schema":{"type":"array","description":"comma separated list of fields to return (c.f. URLs Datamodel)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-user-projects":{"get":{"operationId":"analytics_botify_get_user_projects","summary":"List all active projects for the user","description":"GET /projects/{username}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/test-url-rewriting-rules":{"post":{"operationId":"analytics_botify_test_url_rewriting_rules","summary":"Match and replace parts of a URL based on rules passed in POST data","description":"POST /projects/{username}/{project_slug}/features/url_rewriting/rules_validator","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project_slug"],"properties":{"username":{"type":"string","description":"User's identifier"},"project_slug":{"type":"string","description":"Project's identifier"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-saved-filters":{"get":{"operationId":"analytics_botify_get_saved_filters","summary":"List all the project's saved filters (each filter's name, ID and filter value)","description":"GET /projects/{username}/{project_slug}/filters","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"page","in":"query","required":false,"description":"Page Number","schema":{"type":"integer","description":"Page Number"}},{"name":"size","in":"query","required":false,"description":"Page Size","schema":{"type":"integer","description":"Page Size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-saved-filter":{"get":{"operationId":"analytics_botify_get_saved_filter","summary":"Retrieves a specific saved filter's name, ID and filter value","description":"GET /projects/{username}/{project_slug}/filters/{identifier}","tags":["analytics"],"parameters":[{"name":"username","in":"query","required":true,"description":"User's identifier","schema":{"type":"string","description":"User's identifier"}},{"name":"project_slug","in":"query","required":true,"description":"Project's identifier","schema":{"type":"string","description":"Project's identifier"}},{"name":"identifier","in":"query","required":true,"description":"Saved Filter's identifier","schema":{"type":"string","description":"Saved Filter's identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:botify/get-project-urls-aggs":{"post":{"operationId":"analytics_botify_get_project_urls_aggs","summary":"Project Query aggregator","description":"POST /projects/{username}/{project_slug}/urls/aggs","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","project_slug"],"properties":{"username":{"type":"string","description":"User's identifier"},"project_slug":{"type":"string","description":"Project's identifier"},"area":{"type":"string","enum":["current","disappeared","new"],"default":"current","description":"Analysis context to execute the queries"},"last_analysis_slug":{"type":"string","description":"Last analysis on the trend"},"nb_analyses":{"type":"integer","default":20,"description":"Max number of analysis to return"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}