> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adside.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Budgets

> Refresh and read current campaign budgets

CLI: `adside reporting budgets`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/reporting/budgets
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/reporting/budgets:
    get:
      tags:
        - Reporting
      summary: Budgets
      description: |-
        Refresh and read current campaign budgets

        CLI: `adside reporting budgets`
      operationId: reporting.budgets
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  snapshots:
                    type: array
                    items:
                      type: object
                      properties:
                        source:
                          type: string
                          enum:
                            - META
                            - TIKTOK
                            - GOOGLE
                            - LINKEDIN
                            - SNAPCHAT
                            - REDDIT
                        connectionKey:
                          type: string
                        status:
                          type: string
                          enum:
                            - cached
                            - current
                            - stale
                        fetchedAt:
                          anyOf:
                            - type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                            - type: 'null'
                        campaigns:
                          anyOf:
                            - type: array
                              items:
                                type: object
                                properties:
                                  source:
                                    type: string
                                    enum:
                                      - META
                                      - TIKTOK
                                      - GOOGLE
                                      - LINKEDIN
                                      - SNAPCHAT
                                      - REDDIT
                                  campaignId:
                                    type: string
                                  campaignName:
                                    type: string
                                  objective:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  dailyBudget:
                                    anyOf:
                                      - type: number
                                      - type: 'null'
                                  budgetId:
                                    type: string
                                  lifetimeBudget:
                                    anyOf:
                                      - type: number
                                      - type: 'null'
                                required:
                                  - source
                                  - campaignId
                                  - campaignName
                                  - objective
                                  - dailyBudget
                                  - lifetimeBudget
                                additionalProperties: false
                            - type: 'null'
                      required:
                        - source
                        - status
                        - fetchedAt
                        - campaigns
                      additionalProperties: false
                required:
                  - snapshots
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.