Created
December 10, 2015 16:43
-
-
Save zallek/4a263b70a2d7c1da28ac to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "info": { | |
| "version": "1.0.0", | |
| "description": "Botify Saas API", | |
| "title": "Botify API", | |
| "x-codegen-settings": { | |
| "useMethodPrefix": false, | |
| "useModelPostfix": false, | |
| "useControllerPostfix": false, | |
| "useEnumPostfix": false, | |
| "useConstructorsForConfig": false, | |
| "collectParameters": true, | |
| "brandLabel": "Botify", | |
| "nodeHttpClient": "NODE_SUPERAGENT" | |
| } | |
| }, | |
| "paths": { | |
| "/analyses/{username}/{project_slug}/{analysis_slug}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/AnalysisDetail" | |
| } | |
| } | |
| }, | |
| "description": "Gets an Analysis detail", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Gets an Analysis detail", | |
| "operationId": "getAnalysisSummary" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Return global statistics for an analysis", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Return global statistics for an analysis", | |
| "operationId": "getCrawlStatistics" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Return statistics by 1mn, 5mn or 60mn for an analysis", | |
| "parameters": [ | |
| { | |
| "description": "max number of elements to retrieve", | |
| "format": "int32", | |
| "required": false, | |
| "in": "query", | |
| "type": "integer", | |
| "name": "limit" | |
| }, | |
| { | |
| "description": "frequency of sampling", | |
| "required": true, | |
| "type": "string", | |
| "name": "frequency", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Return statistics by 1mn, 5mn or 60mn for an analysis", | |
| "operationId": "getCrawlStatisticsByFrequency" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "list_type", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Return a list of 1000 latest URLs crawled or with errors", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Return a list of 1000 latest URLs crawled or with errors", | |
| "operationId": "getCrawlStatisticsUrls" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "medium", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "source", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Orphan URLs", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Orphan URLs", | |
| "operationId": "getGanalyticsOrphanURLs" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Links percentiles", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Links percentiles", | |
| "operationId": "getLinksPercentiles" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Lost pagerank", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Lost pagerank", | |
| "operationId": "getPageRankLost" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Sitemaps reports", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Sitemaps reports", | |
| "operationId": "getSitemapsReport" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Sitemaps samples: out of config", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Sitemaps samples: out of config", | |
| "operationId": "getSitemapsSamplesOutOfConfig" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Sitemaps samples: only sitemaps", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Sitemaps samples: only sitemaps", | |
| "operationId": "getSitemapsSamplesSitemapsOnly" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Top domains", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Top domains", | |
| "operationId": "getLinksTopDomains" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Top subddomains", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Top subddomains", | |
| "operationId": "getLinksTopSubdomains" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/insights": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Filters the selected insights with the filters passed on POST", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/InsightsQuery" | |
| }, | |
| "name": "InsightsQuery", | |
| "in": "body" | |
| }, | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| }, | |
| { | |
| "description": "", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "required": true, | |
| "collectionFormat": "csv", | |
| "in": "query", | |
| "type": "array", | |
| "name": "insight_identifiers" | |
| }, | |
| { | |
| "description": "", | |
| "format": "int32", | |
| "default": 20, | |
| "required": false, | |
| "maximum": "20", | |
| "minimum": "1", | |
| "in": "query", | |
| "type": "integer", | |
| "name": "trend_limit" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Filters the selected insights with the filters passed on POST", | |
| "operationId": "getInsights" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ] | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/insights/{insight_identifier}/suggested_filters": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "insight_identifier", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Return most frequent segments (= suggested patterns in the previous version) for a Botify Query (fetched here by an QueryInsight instance) Raise a 404 if the insight is not a QueryInsight object", | |
| "parameters": [ | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Return most frequent segments (= suggested patterns in the previous version)", | |
| "operationId": "getInsightSuggestedFilters" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/pdf": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PDFExportSerializer" | |
| } | |
| } | |
| }, | |
| "description": "Creates a new PDFExport object and starts a task that will generate the file. Returns the model id that manages the task", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/PDFExportSerializer" | |
| }, | |
| "name": "PDFExportSerializer", | |
| "in": "body" | |
| }, | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| }, | |
| { | |
| "description": "", | |
| "default": "overview", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "section" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Creates a new PDFExport object and starts a task that will generate the file", | |
| "operationId": "createPDFExport" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PDFExportSerializer" | |
| } | |
| } | |
| }, | |
| "description": "Get list of PDF Exports", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Get list of PDF Exports", | |
| "operationId": "getPDFExports" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/pdf/{pdf_export_id}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "pdf_export_id", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/PDFExportSerializer" | |
| } | |
| } | |
| }, | |
| "description": "Checks the status of an UrlExport object- - returns json object with the status.", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Checks the status of an UrlExport object-", | |
| "operationId": "getPdfExportStatus" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Executes a query and returns a paginated response", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/UrlsQuery" | |
| }, | |
| "name": "UrlsQuery", | |
| "in": "body" | |
| }, | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| }, | |
| { | |
| "description": "Page Number", | |
| "format": "int32", | |
| "required": false, | |
| "in": "query", | |
| "type": "integer", | |
| "name": "page" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "format": "int32", | |
| "required": false, | |
| "in": "query", | |
| "type": "integer", | |
| "name": "size" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Executes a query and returns a paginated response", | |
| "operationId": "getUrls" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ] | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Query aggregator. It accepts multiple queries", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/UrlsAggsQueries" | |
| }, | |
| "name": "UrlsAggsQueries", | |
| "in": "body" | |
| }, | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Query aggregator", | |
| "operationId": "getUrlsAggs" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ] | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Gets an Analysis datamodel", | |
| "parameters": [ | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Gets an Analysis datamodel", | |
| "operationId": "getUrlsDatamodel" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/export": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlExport" | |
| } | |
| } | |
| }, | |
| "description": "Creates a new UrlExport object and starts a task that will export the results into a csv. Returns the model id that manages the task", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/UrlsQuery" | |
| }, | |
| "name": "UrlsQuery", | |
| "in": "body" | |
| }, | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Creates a new UrlExport object and starts a task that will export the results into a csv", | |
| "operationId": "createUrlExport" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlExport" | |
| } | |
| } | |
| }, | |
| "description": "Get list of Exported Urls", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Get list of Exported Urls", | |
| "operationId": "getUrlsExports" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "url_export_id", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Checks the status of an UrlExport object- - returns json object with the status.", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Checks the status of an UrlExport object-", | |
| "operationId": "getUrlExportStatus" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/fields/{field}/suggest": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "field", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/FieldValues" | |
| } | |
| } | |
| }, | |
| "description": "Return a list of suggested values for a given field", | |
| "parameters": [ | |
| { | |
| "description": "", | |
| "required": false, | |
| "type": "string", | |
| "name": "value", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Return a list of suggested values for a given field", | |
| "operationId": "getUrlsFieldSuggest" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/fields/{field}/top_values": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "field", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/FieldValues" | |
| } | |
| } | |
| }, | |
| "description": "Return a list of top values for a given field", | |
| "parameters": [ | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Return a list of top values for a given field", | |
| "operationId": "getUrlsFieldTopValues" | |
| } | |
| }, | |
| "/analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "analysis_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "url", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/Default" | |
| } | |
| } | |
| }, | |
| "description": "Gets the detail of an URL for an analysis", | |
| "parameters": [ | |
| { | |
| "description": "", | |
| "default": "current", | |
| "required": false, | |
| "in": "query", | |
| "type": "string", | |
| "name": "area" | |
| }, | |
| { | |
| "description": "", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "required": false, | |
| "collectionFormat": "csv", | |
| "in": "query", | |
| "type": "array", | |
| "name": "fields" | |
| } | |
| ], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Gets the detail of an URL for an analysis", | |
| "operationId": "getUrlDetail" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/filters": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| } | |
| } | |
| }, | |
| "description": "Creates a new project's saved query.", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| }, | |
| "name": "UrlsFilter", | |
| "in": "body" | |
| } | |
| ], | |
| "tags": [ | |
| "Project" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Creates a new project's saved query", | |
| "operationId": "createSavedFilter" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| } | |
| } | |
| }, | |
| "description": "List all the project's saved queries", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Project" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "List all the project's saved queries", | |
| "operationId": "getSavedFilters" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/filters/{identifier}": { | |
| "put": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| } | |
| } | |
| }, | |
| "description": "Updates a Saved Query", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| }, | |
| "name": "UrlsFilter", | |
| "in": "body" | |
| } | |
| ], | |
| "tags": [ | |
| "Project" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Updates a Saved Query", | |
| "operationId": "updateSavedFilter" | |
| }, | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| } | |
| } | |
| }, | |
| "description": "Retrieves a Saved Query", | |
| "parameters": [], | |
| "tags": [ | |
| "Project" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Retrieves a Saved Query", | |
| "operationId": "getSavedFilter" | |
| }, | |
| "delete": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| } | |
| } | |
| }, | |
| "description": "Deletes a Saved Query", | |
| "parameters": [], | |
| "tags": [ | |
| "Project" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Deletes a Saved Query", | |
| "operationId": "deleteSavedFilter" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "identifier", | |
| "in": "path" | |
| } | |
| ], | |
| "patch": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| } | |
| } | |
| }, | |
| "description": "Partially updates a Saved Query", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/UrlsFilter" | |
| }, | |
| "name": "UrlsFilter", | |
| "in": "body" | |
| } | |
| ], | |
| "tags": [ | |
| "Project" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Partially updates a Saved Query", | |
| "operationId": "patchSavedFilter" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/segments/datasets": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "List Segments Dataset", | |
| "parameters": [], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "List Segments Dataset", | |
| "operationId": "getDatasets" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/segments/dry_run": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/DryRun" | |
| } | |
| } | |
| }, | |
| "description": "Creates a new Segment Rule on Dry Run", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/DryRun" | |
| }, | |
| "name": "DryRun", | |
| "in": "body" | |
| } | |
| ], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Creates a new Segment Rule on Dry Run", | |
| "operationId": "createDryRun" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/DryRun" | |
| } | |
| } | |
| }, | |
| "description": "List of all Project segment rules on Dry Run", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "List of all Project segment rules on Dry Run", | |
| "operationId": "getDryRunSegments" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/segments/dry_run/{dry_run_id}": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "dry_run_id", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/DryRun" | |
| } | |
| } | |
| }, | |
| "description": "Checks the status of an Project Segment Dry Run. Returns json object with the status.", | |
| "parameters": [], | |
| "tags": [ | |
| "Analysis" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Checks the status of an Project Segment Dry Run", | |
| "operationId": "getDryRunSegmentStatus" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/segments/rules": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/SegmentRules" | |
| } | |
| } | |
| }, | |
| "description": "Creates a new Segment Rule", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/SegmentRules" | |
| }, | |
| "name": "SegmentRules", | |
| "in": "body" | |
| } | |
| ], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Creates a new Segment Rule", | |
| "operationId": "createRulesConfig" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/SegmentRules" | |
| } | |
| } | |
| }, | |
| "description": "List of all Project segment rules", | |
| "parameters": [ | |
| { | |
| "description": "Page Number", | |
| "type": "integer", | |
| "name": "page", | |
| "in": "query" | |
| }, | |
| { | |
| "description": "Page Size", | |
| "type": "integer", | |
| "name": "size", | |
| "in": "query" | |
| } | |
| ], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "List of all Project segment rules", | |
| "operationId": "getRulesConfig" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/segments/rules/latest": { | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| } | |
| ], | |
| "get": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/SegmentRules" | |
| } | |
| } | |
| }, | |
| "description": "Retrieves the latest Segment Rule", | |
| "parameters": [], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "Retrieves the latest Segment Rule", | |
| "operationId": "getLatestRulesConfig" | |
| } | |
| }, | |
| "/projects/{username}/{project_slug}/segments/rules/validate": { | |
| "post": { | |
| "responses": { | |
| "default": { | |
| "description": "error payload", | |
| "schema": { | |
| "$ref": "#/definitions/DefaultPayload" | |
| } | |
| }, | |
| "200": { | |
| "description": "Successful operation", | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "validates a Segment Rule", | |
| "parameters": [ | |
| { | |
| "schema": { | |
| "$ref": "#/definitions/SegmentRules" | |
| }, | |
| "name": "SegmentRules", | |
| "in": "body" | |
| } | |
| ], | |
| "tags": [ | |
| "Segment" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "summary": "validates a Segment Rule", | |
| "operationId": "validateRulesConfig" | |
| }, | |
| "parameters": [ | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "username", | |
| "in": "path" | |
| }, | |
| { | |
| "required": true, | |
| "type": "string", | |
| "name": "project_slug", | |
| "in": "path" | |
| } | |
| ] | |
| } | |
| }, | |
| "host": "api.sandbox1.botify.com", | |
| "schemes": [ | |
| "http" | |
| ], | |
| "definitions": { | |
| "UrlsAggsQuery": { | |
| "type": "object", | |
| "properties": { | |
| "filters": { | |
| "readOnly": false, | |
| "type": "object", | |
| "description": "" | |
| }, | |
| "aggs": { | |
| "description": "", | |
| "items": { | |
| "type": "object" | |
| }, | |
| "readOnly": false, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "DryRun": { | |
| "required": [ | |
| "rules_config", | |
| "dataset", | |
| "sample_percent" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "job_id": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "job_url": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "job_status": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "rules_config": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "dataset": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "sample_percent": { | |
| "description": "", | |
| "format": "int64", | |
| "maximum": 2147483647, | |
| "readOnly": false, | |
| "minimum": 0, | |
| "type": "integer" | |
| }, | |
| "filter_predicate": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "filter_value": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "UrlsQuery": { | |
| "type": "object", | |
| "properties": { | |
| "fields": { | |
| "readOnly": false, | |
| "type": "object", | |
| "description": "" | |
| }, | |
| "filters": { | |
| "readOnly": false, | |
| "type": "object", | |
| "description": "" | |
| }, | |
| "sort": { | |
| "description": "", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "readOnly": false, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "Default": { | |
| "type": "object", | |
| "properties": {} | |
| }, | |
| "UrlsFilter": { | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "filters": { | |
| "readOnly": false, | |
| "type": "object", | |
| "description": "" | |
| }, | |
| "identifier": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "PDFExportSerializer": { | |
| "type": "object", | |
| "properties": { | |
| "job_id": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "job_url": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "job_status": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "results": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "area": { | |
| "readOnly": false, | |
| "defaultValue": "current", | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "section": { | |
| "readOnly": false, | |
| "defaultValue": "overview", | |
| "type": "string", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "InsightsQuery": { | |
| "type": "object", | |
| "properties": { | |
| "additional_filters": { | |
| "readOnly": false, | |
| "type": "object", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "UrlsAggsQueries": { | |
| "items": { | |
| "$ref": "#/definitions/UrlsAggsQuery" | |
| }, | |
| "type": "array" | |
| }, | |
| "FieldValuesResult": { | |
| "required": [ | |
| "value", | |
| "nb_urls" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "value": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "nb_urls": { | |
| "readOnly": false, | |
| "type": "integer", | |
| "description": "", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "DefaultPayload": { | |
| "type": "object", | |
| "description": "default payload for object for all HTTP codes that are not covered individually", | |
| "properties": { | |
| "error": { | |
| "type": "object", | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "description": "Error Message" | |
| }, | |
| "error_code": { | |
| "type": "string", | |
| "description": "Error Code" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "User": { | |
| "type": "object", | |
| "properties": { | |
| "login": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "email": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "is_organization": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "url": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "date_joined": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "first_name": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "last_name": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "company_name": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "SegmentRules": { | |
| "required": [ | |
| "config" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "readOnly": true, | |
| "type": "integer", | |
| "description": "", | |
| "format": "int64" | |
| }, | |
| "config": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "date_created": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "UrlExport": { | |
| "required": [ | |
| "task_status" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "date_created": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| }, | |
| "date_started": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| }, | |
| "date_completed": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| }, | |
| "nb_results": { | |
| "description": "", | |
| "format": "int64", | |
| "maximum": 2147483647, | |
| "readOnly": false, | |
| "minimum": 0, | |
| "type": "integer" | |
| }, | |
| "task_status": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "AnalysisDetail": { | |
| "required": [ | |
| "user" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "readOnly": true, | |
| "type": "integer", | |
| "description": "", | |
| "format": "int64" | |
| }, | |
| "user": { | |
| "readOnly": false, | |
| "description": "", | |
| "$ref": "#/definitions/User" | |
| }, | |
| "slug": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "name": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "url": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "features": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "urls_done": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "urls_in_queue": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "config": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "date_launched": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| }, | |
| "date_finished": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "", | |
| "format": "date-time" | |
| }, | |
| "date_last_modified": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "Date of last modified analysis", | |
| "format": "date-time" | |
| }, | |
| "failures": { | |
| "readOnly": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "red_button_domain": { | |
| "readOnly": false, | |
| "type": "string", | |
| "description": "" | |
| } | |
| } | |
| }, | |
| "FieldValues": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "readOnly": false, | |
| "type": "integer", | |
| "description": "", | |
| "format": "int64" | |
| }, | |
| "results": { | |
| "description": "", | |
| "items": { | |
| "$ref": "#/definitions/FieldValuesResult" | |
| }, | |
| "readOnly": false, | |
| "type": "array" | |
| } | |
| } | |
| } | |
| }, | |
| "basePath": "/v1", | |
| "swagger": "2.0", | |
| "securityDefinitions": { | |
| "DjangoRestToken": { | |
| "type": "apiKey", | |
| "name": "Authorization", | |
| "in": "header" | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment