---
agentTools:
  projectIndex: https://awr.readme.io/llms.txt
---

# Estimate On Demand Update

Estimates how many resources you'd need to start an on demand update for one or multiple projects.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Live API endpoint",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.awrcloud.com/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "token",
        "in": "query"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/get.php?action=estimate_on_demand": {
      "get": {
        "summary": "Estimate On Demand Update",
        "description": "Estimates how many resources you'd need to start an on demand update for one or multiple projects.",
        "operationId": "estimate-on-demand-update",
        "parameters": [
          {
            "name": "projectIds",
            "in": "query",
            "description": "Comma separated project IDs: 1,2,3. Use -1 to get estimates for all your projects.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "1,2,3"
            }
          },
          {
            "name": "speed",
            "in": "query",
            "description": "Can be:<br/>- slow (rankings are delivered within 48h)<br/>- fast (data is available within 12h)<br/>- ultrafast (data is available within 1h).",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "slow",
                "fast",
                "ultrafast"
              ],
              "default": "slow"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "\"old_keyword_units\" - how many keyword units you are currently using\n\"new_keyword_units\" - how many keyword units you would end up using if you started an update for all eligible projects\n\n{\n  \"old_keyword_units\": \"57486\",\n  \"new_keyword_units\": 63411,\n  \"plan_keyword_units\": 160000,\n  \"websites\": {\n    \"2\": {\n      \"project\": \"allrecipes.com\",\n      \"response_code\": 0,\n      \"message\": \"Project is eligible for the slow update.\",\n      \"used_keyword_units\": 5345\n    },\n    \"4\": {\n      \"project\": \"4\",\n      \"response_code\": 7,\n      \"message\": \"Project does not exist. Update cannot be started.\"\n    },\n    \"6\": {\n      \"project\": \"6\",\n      \"response_code\": 7,\n      \"message\": \"Project does not exist. Update cannot be started.\"\n    },\n    \"16\": {\n      \"project\": \"mtv.com\",\n      \"response_code\": 0,\n      \"message\": \"Project is eligible for the slow update.\",\n      \"used_keyword_units\": 580\n    }\n  }\n}"
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "69833d45353ab6e6bda409ad:6983474a32aec46f81d93cd2"
}
```