---
updatedAt: 2026-05-27T06:01:58.000Z
agentTools:
  projectIndex: https://developers.botify.com/llms.txt
---

# /analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel

Gets an Analysis datamodel

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "description": "Botify Saas API",
    "title": "Botify API"
  },
  "paths": {
    "/analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel": {
      "get": {
        "description": "Gets an Analysis datamodel",
        "summary": "",
        "operationId": "getUrlsDatamodel",
        "tags": [
          "Analysis"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "area",
            "required": false,
            "description": "Analysis context",
            "schema": {
              "type": "string",
              "enum": [
                "current",
                "disappeared",
                "new",
                "search_engines_orphans",
                "gsc_keywords",
                "gsc_keywords_by_country"
              ],
              "default": "current"
            }
          },
          {
            "in": "query",
            "name": "previous_crawl",
            "required": false,
            "description": "Previous analysis identifier",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Datamodel"
                }
              }
            }
          },
          "default": {
            "description": "error payload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DefaultPayload"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "username",
          "in": "path",
          "required": true,
          "description": "User's identifier",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "project_slug",
          "in": "path",
          "required": true,
          "description": "Project's identifier",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "analysis_slug",
          "in": "path",
          "required": true,
          "description": "Analysis' identifier",
          "schema": {
            "type": "string"
          }
        }
      ]
    }
  },
  "security": [
    {
      "DjangoRestToken": []
    }
  ],
  "servers": [
    {
      "url": "https://api.botify.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "DjangoRestToken": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "DatamodelGroup": {
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object",
        "required": [
          "id",
          "name"
        ]
      },
      "DatamodelField": {
        "properties": {
          "multiple": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "subtype": {
            "type": "string"
          },
          "group": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "permissions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "aliases": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "optional": {
            "type": "boolean"
          },
          "suggestion": {
            "type": "boolean"
          }
        },
        "type": "object",
        "required": [
          "multiple",
          "name",
          "subtype",
          "group",
          "type",
          "id",
          "permissions",
          "optional"
        ]
      },
      "Datamodel": {
        "properties": {
          "fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DatamodelField"
            }
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DatamodelGroup"
            }
          },
          "max_timeseries_fields": {
            "type": "integer",
            "format": "int64"
          },
          "aliases": {
            "type": "object"
          }
        },
        "type": "object",
        "required": [
          "fields",
          "groups"
        ]
      },
      "DefaultPayload": {
        "type": "object",
        "description": "default payload for object for all HTTP codes that are not covered individually",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "message": {
                "description": "Error Message",
                "type": "string"
              },
              "error_code": {
                "description": "Error Code",
                "type": "string"
              },
              "error_detail": {
                "description": "If available, detailed error",
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}
```