Skip to content

Instantly share code, notes, and snippets.

@pleasedontbelong
Last active August 29, 2015 14:25
Show Gist options
  • Save pleasedontbelong/fe8ad72b620d7a6f6860 to your computer and use it in GitHub Desktop.
Save pleasedontbelong/fe8ad72b620d7a6f6860 to your computer and use it in GitHub Desktop.
{"info":{"contact":"apiteam@wordnik.com","description":"This is a sample server Petstore server. You can find out more about Swagger at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters","title":"Swagger Sample App"},"paths":{"/{version}/analyses/{crawl_id}/features/pagerank/lost":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/top_domains/domains/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/insights/{insight_identifier}/segments/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"insight_identifier"}],"get":{"description":"<p>Return most frequent segments (= suggested patterns in the previous version)\nfor a Botify Query (fetched here by an QueryInsight instance)\nRaise a 404 if the insight is not a QueryInsight object</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Insight_Segment_GET","externalDocs":"TODO","tags":"TODO","summary":"Return most frequent segments (= suggested patterns in the previous version)"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/config/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Config_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/insights/":{"post":{"description":"<p>Take additional_filters as POST arg and apply it to all insights</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Insights_POST","externalDocs":"TODO","tags":"TODO","summary":"Take additional_filters as POST arg and apply it to all insights"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Insights_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/insights/":{"post":{"description":"<p>Take additional_filters as POST arg and apply it to all insights</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Insights_POST","externalDocs":"TODO","tags":"TODO","summary":"Take additional_filters as POST arg and apply it to all insights"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Insights_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/features/top_domains/subdomains/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/projects/{username}/{project_slug}/filters/":{"post":{"description":"","produces":["application/json","text/html"],"type":"ProjectQuerySerializer","operationId":"Project_Query_List_Create_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"ProjectQuerySerializer","operationId":"Project_Query_List_Create_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/datamodel/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Datamodel_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/contacts/":{"post":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Contact_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[]},"/{version}/{username}/last_seen_urls/{url}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"url"}],"get":{"description":"<p>Return an URL recently crawled by user</p>","produces":["application/json","text/html"],"type":"object","operationId":"Url_Last_Seen_GET","externalDocs":"TODO","tags":"TODO","summary":"Return an URL recently crawled by user"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/aggs/":{"post":{"description":"<p>Aggregator Query on cdf. It accepts multiple queries</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Aggs_POST","externalDocs":"TODO","tags":"TODO","summary":"Aggregator Query on cdf"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}]},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/statistics/urls/{list_type}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"list_type"}],"get":{"description":"<p>Return a list of 1000 latest URLs crawled or with error, displayed on the\nStatistics page</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Statistics_Urls_GET","externalDocs":"TODO","tags":"TODO","summary":"Return a list of 1000 latest URLs crawled or with error, displayed on the"}},"/{version}/analyses/{crawl_id}/statistics/urls/{list_type}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"list_type"}],"get":{"description":"<p>Return a list of 1000 latest URLs crawled or with error, displayed on the\nStatistics page</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Statistics_Urls_GET","externalDocs":"TODO","tags":"TODO","summary":"Return a list of 1000 latest URLs crawled or with error, displayed on the"}},"/{version}/analyses/{crawl_id}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/revisions/{pk}/ganalytics/":{"patch":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Ganalytics_Feature_Detail_PATCH","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"pk"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Ganalytics_Feature_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/revisions/{pk}/ganalytics/":{"patch":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Ganalytics_Feature_Detail_PATCH","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"pk"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Ganalytics_Feature_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/revisions/":{"post":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_List_POST","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_List_GET","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/settings/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Settings_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/statistics/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"query","type":"string","name":"stats_type","description":"\"count\" or \"status\""}],"get":{"description":"<p>Return statistics for a crawl</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Statistics_GET","externalDocs":"TODO","tags":"TODO","summary":"Return statistics for a crawl"}},"/{version}/analyses/{crawl_id}/features/links/percentiles/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/urls/":{"post":{"description":"<p>Query cdf and returns a paginated response</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Urls_POST","externalDocs":"TODO","tags":"TODO","summary":"Query cdf and returns a paginated response"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}]},"/{version}/analyses/{crawl_id}/analysis_events/":{"post":{"description":"<p>Post a new event related to a specific crawl.</p>","produces":["application/json","text/html"],"type":"object","operationId":"Pocket_Crawler_Event_List_POST","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawl"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Post a new event related to a specific crawl.</p>","produces":["application/json","text/html"],"type":"object","operationId":"Pocket_Crawler_Event_List_GET","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawl"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/urls_export/{urlexport_id}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"urlexport_id"}],"get":{"description":"<p>Checks the status of a UrlExport object-\n- returns json object with the status.</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Url_Export_Status_GET","externalDocs":"TODO","tags":"TODO","summary":"Checks the status of a UrlExport object-"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/urls_export/disappeared/":{"post":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/datamodel/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Datamodel_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/{username}/{project_slug}/features/extract/rules_validator/":{"post":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Test_Extract_Rule_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"}]},"/{version}/analyses/{crawl_id}/revisions/{pk}/":{"patch":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Detail_PATCH","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"pk"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/sitemaps/samples/sitemap_only/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/workflow_events/":{"post":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Workflow_Event_List_POST","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Workflow_Event_List_GET","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"}},"/{version}/analyses/{crawl_id}/features/sitemaps/samples/sitemap_only/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{crawl_id}/urls/":{"post":{"description":"<p>Query cdf and returns a paginated response</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Urls_POST","externalDocs":"TODO","tags":"TODO","summary":"Query cdf and returns a paginated response"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}]},"/{version}/insights/{pk}/":{"put":{"description":"<p>A simple ViewSet that for listing or retrieving insights</p>","produces":["application/json","text/html"],"type":"InsightSerializer","operationId":"Insight_update","externalDocs":"TODO","tags":"TODO","summary":"A simple ViewSet that for listing or retrieving insights"},"delete":{"description":"<p>A simple ViewSet that for listing or retrieving insights</p>","produces":["application/json","text/html"],"type":"InsightSerializer","operationId":"Insight_destroy","externalDocs":"TODO","tags":"TODO","summary":"A simple ViewSet that for listing or retrieving insights"},"patch":{"description":"<p>A simple ViewSet that for listing or retrieving insights</p>","produces":["application/json","text/html"],"type":"InsightSerializer","operationId":"Insight_partial_update","externalDocs":"TODO","tags":"TODO","summary":"A simple ViewSet that for listing or retrieving insights"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"pk"},{"name":"obj_type","paramType":"form","required":true,"type":"string","description":""},{"name":"identifier","paramType":"form","required":true,"type":"string","description":""},{"name":"verbose_name","paramType":"form","required":true,"type":"string","description":""},{"name":"verbose_name_new","paramType":"form","required":false,"type":"string","description":""},{"name":"verbose_name_disappeared","paramType":"form","required":false,"type":"string","description":""},{"enum":["main","links","semantic_metadata","ganalytics","main_image","sitemaps","rel","comparison","extract","duplicate_query_kvs"],"name":"feature","paramType":"form","required":true,"type":"choice","description":""},{"enum":["up","down","unknown"],"name":"trend","paramType":"form","required":true,"type":"choice","description":""},{"enum":["long","integer","float","string","boolean","date"],"name":"return_type","paramType":"form","required":true,"type":"choice","description":""},{"enum":["url","depth","link","visit","time_sec","time_millisec","percent"],"name":"unit","paramType":"form","required":true,"type":"choice","description":""}],"get":{"description":"<p>A simple ViewSet that for listing or retrieving insights</p>","produces":["application/json","text/html"],"type":"InsightSerializer","operationId":"Insight_retrieve","externalDocs":"TODO","tags":"TODO","summary":"A simple ViewSet that for listing or retrieving insights"}},"/{version}/analyses/{crawl_id}/urls_export/disappeared/":{"post":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/sitemaps/report/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/statistics/time/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Return statistics by 1mn, 5mn or 60mn for a crawl</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Statistics_Time_GET","externalDocs":"TODO","tags":"TODO","summary":"Return statistics by 1mn, 5mn or 60mn for a crawl"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/ganalytics/orphan_urls/{medium}/{source}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"medium"},{"paramType":"path","required":true,"type":"string","name":"source"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/top_domains/subdomains/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{crawl_id}/features/ganalytics/orphan_urls/{medium}/{source}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"medium"},{"paramType":"path","required":true,"type":"string","name":"source"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/analysis_events/":{"post":{"description":"<p>Post a new event related to a specific crawl.</p>","produces":["application/json","text/html"],"type":"object","operationId":"Pocket_Crawler_Event_List_POST","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawl"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Post a new event related to a specific crawl.</p>","produces":["application/json","text/html"],"type":"object","operationId":"Pocket_Crawler_Event_List_GET","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawl"}},"/{version}/analyses/{crawl_id}/urls/{url}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"url"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Url_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/insights/":{"post":{"description":"<p>A simple ViewSet that for listing or retrieving insights</p>","produces":["application/json","text/html"],"type":"InsightSerializer","operationId":"Insight_create","externalDocs":"TODO","tags":"TODO","summary":"A simple ViewSet that for listing or retrieving insights"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"name":"obj_type","paramType":"form","required":true,"type":"string","description":""},{"name":"identifier","paramType":"form","required":true,"type":"string","description":""},{"name":"verbose_name","paramType":"form","required":true,"type":"string","description":""},{"name":"verbose_name_new","paramType":"form","required":false,"type":"string","description":""},{"name":"verbose_name_disappeared","paramType":"form","required":false,"type":"string","description":""},{"enum":["main","links","semantic_metadata","ganalytics","main_image","sitemaps","rel","comparison","extract","duplicate_query_kvs"],"name":"feature","paramType":"form","required":true,"type":"choice","description":""},{"enum":["up","down","unknown"],"name":"trend","paramType":"form","required":true,"type":"choice","description":""},{"enum":["long","integer","float","string","boolean","date"],"name":"return_type","paramType":"form","required":true,"type":"choice","description":""},{"enum":["url","depth","link","visit","time_sec","time_millisec","percent"],"name":"unit","paramType":"form","required":true,"type":"choice","description":""}],"get":{"description":"<p>A simple ViewSet that for listing or retrieving insights</p>","produces":["application/json","text/html"],"type":"InsightSerializer","operationId":"Insight_list","externalDocs":"TODO","tags":"TODO","summary":"A simple ViewSet that for listing or retrieving insights"}},"/{version}/analyses/{crawl_id}/insights/{insight_identifier}/segments/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"insight_identifier"}],"get":{"description":"<p>Return most frequent segments (= suggested patterns in the previous version)\nfor a Botify Query (fetched here by an QueryInsight instance)\nRaise a 404 if the insight is not a QueryInsight object</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Insight_Segment_GET","externalDocs":"TODO","tags":"TODO","summary":"Return most frequent segments (= suggested patterns in the previous version)"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/sitemaps/samples/out_of_config/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/links/percentiles/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/users/{username}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"}],"get":{"description":"<p>Retrieve a user's information. If username is equal to \"me\" it will\nreturn the information of the authenticated user</p>","produces":["application/json","text/html"],"type":"UserSerializer","operationId":"User_Retrieve_GET","externalDocs":"TODO","tags":"TODO","summary":"Retrieve a user's information"}},"/tokens/":{"post":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Obtain_Auth_Token_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[]},"/{version}/analyses/{crawl_id}/aggs/":{"post":{"description":"<p>Aggregator Query on cdf. It accepts multiple queries</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Aggs_POST","externalDocs":"TODO","tags":"TODO","summary":"Aggregator Query on cdf"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}]},"/{version}/analyses/{crawl_id}/urls_export/{urlexport_id}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"},{"paramType":"path","required":true,"type":"string","name":"urlexport_id"}],"get":{"description":"<p>Checks the status of a UrlExport object-\n- returns json object with the status.</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Url_Export_Status_GET","externalDocs":"TODO","tags":"TODO","summary":"Checks the status of a UrlExport object-"}},"/{version}/analyses/{crawl_id}/config/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Config_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/settings/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Settings_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/revisions/{pk}/":{"patch":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Detail_PATCH","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"pk"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/projects/{username}/{project_slug}/filters/{identifier}/":{"put":{"description":"","produces":["application/json","text/html"],"type":"ProjectQuerySerializer","operationId":"Project_Query_Retrieve_Update_Destroy_PUT","externalDocs":"TODO","tags":"TODO","summary":""},"delete":{"description":"","produces":["application/json","text/html"],"type":"ProjectQuerySerializer","operationId":"Project_Query_Retrieve_Update_Destroy_DELETE","externalDocs":"TODO","tags":"TODO","summary":""},"patch":{"description":"","produces":["application/json","text/html"],"type":"ProjectQuerySerializer","operationId":"Project_Query_Retrieve_Update_Destroy_PATCH","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"identifier"}],"get":{"description":"","produces":["application/json","text/html"],"type":"ProjectQuerySerializer","operationId":"Project_Query_Retrieve_Update_Destroy_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/users/{username}/allowed_domains/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"}],"get":{"description":"<p>List of allowed domains for a defined username.</p>","produces":["application/json","text/html"],"type":"SiteSerializer","operationId":"User_Allowed_Domains_GET","externalDocs":"TODO","tags":"TODO","summary":"List of allowed domains for a defined username"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/statistics/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"query","type":"string","name":"stats_type","description":"\"count\" or \"status\""}],"get":{"description":"<p>Return statistics for a crawl</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Statistics_GET","externalDocs":"TODO","tags":"TODO","summary":"Return statistics for a crawl"}},"/{version}/analyses/{crawl_id}/statistics/time/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Return statistics by 1mn, 5mn or 60mn for a crawl</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Statistics_Time_GET","externalDocs":"TODO","tags":"TODO","summary":"Return statistics by 1mn, 5mn or 60mn for a crawl"}},"/{version}/analyses/{crawl_id}/features/top_domains/domains/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/revisions/":{"post":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_List_POST","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Revision_List_GET","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/urls_export/":{"post":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{crawl_id}/workflow_events/":{"post":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Workflow_Event_List_POST","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Post a new event related to a specific crawled. Used internally by the workflow to update its progress</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Workflow_Event_List_GET","externalDocs":"TODO","tags":"TODO","summary":"Post a new event related to a specific crawled"}},"/{version}/analyses/{crawl_id}/urls_export/":{"post":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_POST","externalDocs":"TODO","tags":"TODO","summary":""},"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"","produces":["application/json","text/html"],"type":"UrlExportSerializer","operationId":"Crawl_Url_Export_GET","externalDocs":"TODO","tags":"TODO","summary":""}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/features/pagerank/lost":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{crawl_id}/features/sitemaps/report/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{crawl_id}/features/sitemaps/samples/out_of_config/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"crawl_id"}],"get":{"description":"<p>Fetch a static file from S3 with a JSON representation or a TSV\nGunzip it if necessary</p>","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Paginated_Static_File_GET","externalDocs":"TODO","tags":"TODO","summary":"Fetch a static file from S3 with a JSON representation or a TSV"}},"/{version}/analyses/{username}/{project_slug}/{crawl_slug}/urls/{url}/":{"parameters":[{"paramType":"path","required":true,"type":"string","name":"version"},{"paramType":"path","required":true,"type":"string","name":"username"},{"paramType":"path","required":true,"type":"string","name":"project_slug"},{"paramType":"path","required":true,"type":"string","name":"crawl_slug"},{"paramType":"path","required":true,"type":"string","name":"url"}],"get":{"description":"","produces":["application/json","text/html"],"type":"object","operationId":"Crawl_Url_Detail_GET","externalDocs":"TODO","tags":"TODO","summary":""}}},"swagger":"2.0"}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment