REredis
Account

Generate cost report

Changed on

Generates a cost report in FOCUS format for the specified time period (max 40 days range) and filters. Read more about focus here.

post/v1/cost-report

Request

  • Base URL
    https://api.redislabs.com
  • URL
    https://api.redislabs.com/v1/cost-report
  • Auth
    API key in header x-api-key and API key in header x-api-secret-key and API key in header x-auth-token

Request body

startDatestring YYYY-MM-DD required

Filter for usage starting on or after this date. Must be in format YYYY-MM-DD

endDatestring YYYY-MM-DD required

Filter for usage ending on or before this date. Must be in format YYYY-MM-DD and must be after start date

format'json' | 'csv'

Output format for the cost report

subscriptionIdsinteger[]

Array of subscriptionIDs to filter by

databaseIdsinteger[]

Array of database IDs to filter by

subscriptionType'pro' | 'essentials'

Filter by plan type

regionsstring[]

Array of regions to filter by

commandTypestring

Example request

{
  "startDate": "2025-10-01",
  "endDate": "2025-11-06",
  "format": "csv",
  "subscriptionIds": [
    123,
    456
  ],
  "databaseIds": [
    789,
    101112
  ],
  "subscriptionType": "pro",
  "regions": [
    "us-east-1",
    "eu-west-1"
  ],
  "tags": [
    {
      "key": "environment",
      "value": "production"
    }
  ]
}

Response

Accepted

taskIdstring uuid
commandTypestring
status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'
descriptionstring
timestampstring date-time
linksobject[]

Changes

  • 6b256e1bb946Revision changes
    • warning

      added the new AGENT_MEMORY_IS_DISABLED enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_DEPENDENCY_FAILED enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_FORBIDDEN enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_INVALID_REQUEST enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_NOT_FOUND enum value to the / response property for the response status

  • c09dc0db14e1Revision changes
    • warning

      added the new DATABASE_IN_ACTIVE_ENDPOINTS_REDIRECTION enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_NOT_STOPPED enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_RESUME_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_RESUME_NOT_ELIGIBLE enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_STATE_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new DB_ENDPOINTS_SERVICE_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_ACCOUNT_MISMATCH enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_ALREADY_EXISTS enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_CONNECTIVITY_MISMATCH enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DATABASES_NOT_COMPATIBLE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DATABASE_STATE_NOT_SUPPORTED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DNS_SERVICE_NOT_AVAILABLE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_INVALID_ENDPOINT_TYPE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_COMPLETED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_LATEST enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_REVERT_WINDOW_EXCEEDED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_SOURCE_HAS_NO_ENDPOINTS enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_TARGET_HAS_NO_ENDPOINTS enum value to the / response property for the response status

    • warning

      added the new FIXED_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_SUPPORTED_FOR_FREE_PLAN enum value to the / response property for the response status