{
  "opencollection": "1.0.0",
  "info": {
    "name": "Botify Project API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Project",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "getProjectAnalyses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.botify.com/v1/analyses/:username/:project_slug",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page Number"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page Size"
              },
              {
                "name": "only_success",
                "value": "",
                "type": "query",
                "description": "Return only successfully finished analyses"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Which fields to return (comma-separated)"
              }
            ]
          },
          "docs": "List all analyses for a project"
        },
        {
          "info": {
            "name": "getProjectAnalysesLight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.botify.com/v1/analyses/:username/:project_slug/light",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page Number"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page Size"
              },
              {
                "name": "only_success",
                "value": "",
                "type": "query",
                "description": "Return only successfully finished analyses"
              }
            ]
          },
          "docs": "List all analyses for a project (light)"
        },
        {
          "info": {
            "name": "getSavedFilters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.botify.com/v1/projects/:username/:project_slug/filters",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page Number"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page Size"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search query on the filter name"
              }
            ]
          },
          "docs": "List all the project's saved filters (each filter's name, ID and filter value)"
        },
        {
          "info": {
            "name": "getFilter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.botify.com/v1/projects/:username/:project_slug/filters/:identifier",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              },
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a specific project saved, account or recommended filter's name, ID and filter value"
        },
        {
          "info": {
            "name": "projectQuery",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.botify.com/v1/projects/:username/:project_slug/query",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page Number"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page Size"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query collections at a project level."
        },
        {
          "info": {
            "name": "getSavedExplorers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.botify.com/v1/projects/:username/:project_slug/saved_explorers",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              }
            ]
          },
          "docs": "List all the project's Saved Explorers."
        },
        {
          "info": {
            "name": "getProjectUrlsAggs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.botify.com/v1/projects/:username/:project_slug/urls/aggs",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              },
              {
                "name": "area",
                "value": "",
                "type": "query",
                "description": "Analyses context"
              },
              {
                "name": "last_analysis_slug",
                "value": "",
                "type": "query",
                "description": "Last analysis on the trend"
              },
              {
                "name": "nb_analyses",
                "value": "",
                "type": "query",
                "description": "Max number of analysis to return"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Project Query aggregator. It accepts multiple queries that will be executed on all completed analyses in the project"
        },
        {
          "info": {
            "name": "cloneValuesList",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.botify.com/v1/projects/:username/:project_slug/values_list/clone",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              },
              {
                "name": "project_slug",
                "value": "",
                "type": "path",
                "description": "Project's identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clone all keyword groups of the current project to another one.  This endpoint is a little more general (for further use). That's why you will see a 'type' field (with a default value of: 'keywords')."
        },
        {
          "info": {
            "name": "getAllUserProjects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.botify.com/v1/users/:username/projects",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "User's identifier"
              }
            ]
          },
          "docs": "List all active projects for the user"
        }
      ]
    }
  ],
  "bundled": true
}