Reddit Ad Account History API

openapi: 3.2.0
info:
  title: Reddit Advertising Ad Account History API
  version: '3'
  x-logo:
    url: https://www.redditstatic.com/desktop2x/img/favicon/favicon-32x32.png
  description: '## Ads API terms


    By accessing or using the Ads API and/or associated Reddit Data, you are agreeing that you have read, and that you Agree to comply with and to be bound by, the Ads API Terms and all applicable laws and regulations in their entirety without limitation or qualification. The Ads API Terms apply to and govern your access to and use of the Ads API and Reddit Data, constitute a legally binding agreement between you and Reddit, and include certain terms that are defined in the Advertising Platform Terms, Developer Terms, and User Agreement. You may use the Ads API and Reddit Data only in accordance with the Ads API Terms. Use of the Conversions API is subject to the Advertiser Measurement Program Terms in addition to the same agreements as the Ads API. If you do not agree to the Ads API Terms, and Advertiser Measurement Program Terms as applicable, then you must not access or use the Ads API, Conversions API, or Reddit Data. **Note:** The Reddit Ads API is open to all developers and **does not require allowlisting or approval from Reddit to access**. Get started with the API. API partners working on behalf of advertisers can request support by contacting us. See our supported partners. ## Overview


    The Reddit Ads API lets advertisers tap into the Reddit Ads Platform to build and manage advertising campaigns and accounts programmatically. By integrating Reddit Ads API into your tooling, you can streamline workflows, reduce operational overhead, and accelerate the creation, optimization, and reporting of Reddit campaigns without needing to step into the Reddit Ads Manager directly. All API applications must be authenticated with OAuth2 by creating a developer application and obtaining access and refresh tokens. !v3 ERD diagram


    Here are two popular ways to use the Reddit Ads API:


    - **Postman:** A visual client that makes it simpler to set up and start testing requests and responses. This is the fastest way to familiarize yourself with the API if you prefer a point-and-click approach. You can explore our Postman collections. - **Programmatic access:** Use your preferred programming language or command-line tools to create automations and integrations. This approach is ideal if you want to embed API calls into your workflows or build custom tools. ### User agents


    Rate-limiting issues often occur if you haven''t set your user agent to a unique descriptor. Many default user agents (like `“Python/urllib”` or `“Java”`) are drastically limited to encourage unique and descriptive user-agent strings. We recommend following this format for your client''s user agent string:


    ```

    {{Target platform}}:{{Unique app ID}}:{{Version string}} (by /u/{{Your Reddit username}})

    ```


    > **Note:** Including your version number helps us block old buggy or broken versions of your app safely. Just remember to update this string when you update your version number. Example


    ```

    User-Agent: android:com.example.myredditapp:v1.2.3 (by /u/kemitche)

    ```


    > **Important:** Never lie about your user agent! Don''t pretend to be popular browsers or other bots. We''ll ban anyone caught in the act. ### Pagination


    Paginated endpoints respond with a `pagination` object containing up to 2 fields:


    > **Important:** The URLs for these fields should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs. - **`next_url`:** The full URL to access the next page of the response. If not available, the current page is the final page. - **`previous_url`:** The full URL to access the previous page of the response. If not available, the current page is the first page. All endpoints that return a list, such as `List Campaigns` and `Get a Report`, will be paginated. ### Response types


    Response | Description

    --- | ---

    200 | Successfully processed the request. 400 | Request was invalid. See the client error message for specifics. 401 | No bearer token or a bad bearer token was provided. Check your application authentication.'
servers:
- url: https://ads-api.reddit.com/api/v3
  description: Reddit AdsAPI Production
tags:
- name: Ad Account History
  description: Information about ad account history.
paths:
  /ad_accounts/{ad_account_id}/history:
    post:
      description: 'Retrieve the changelog for an ad account.

        > **Tip:** Send an empty JSON object (`{}`) to return all changes made to the ad account.


        Rate Limit


        See the rate limits for Business Manager


        Policy Slug: ads-business-manager


        Window: 60 seconds


        Quota: 100 requests'
      summary: Get Ad Account History
      operationId: get_ad_account_history
      parameters:
      - description: The ad account ID.
        in: path
        name: ad_account_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/components_parameters_page_token'
      - $ref: '#/components/parameters/components_parameters_page_size'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              title: AdAccountHistoryRequestBody
              additionalProperties: false
              properties:
                data:
                  $ref: '#/components/schemas/components_schema_ad_account_history_filter'
      responses:
        '200':
          description: Changes affecting the ad account, from newest to oldest.
          content:
            application/json:
              schema:
                type: object
                title: AdAccountHistoryResponseBody
                additionalProperties: false
                required:
                - data
                - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/components_schema_ad_account_history'
                  pagination:
                    $ref: '#/components/schemas/components_schema_pagination_with_details'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
      - RedditAPIKey:
        - adsread
      tags:
      - Ad Account History
components:
  schemas:
    components_schema_ad_account_history_filter:
      type: object
      additionalProperties: false
      properties:
        start_time:
          type: string
          description: Start of the time window for filtering changes.
          examples:
          - '2023-11-20T03:00:00Z'
          format: date-time
        end_time:
          type: string
          description: End of the time window for filtering changes.
          examples:
          - '2023-11-20T03:00:00Z'
          format: date-time
        member_ids:
          type: array
          description: Filter by the member IDs who made the changes.
          items:
            type: string
          examples:
          - - t2_123
            - t2_456
        change_types:
          type: array
          description: Filter by change types.
          items:
            type: string
            enum:
            - AD_ACCOUNT
            - AD
            - AD_GROUP
            - AUDIENCE
            - BID
            - BUDGET
            - CAMPAIGN
            - STATUS
            - TARGETING
          examples:
          - - AD_ACCOUNT
            - TARGETING
        entity_id_filters:
          type: array
          title: EntityIdFilters
          description: Expanded ID filters for specific campaigns, ad groups, or ads.
          items:
            type: object
            title: EntityIdFilter
            additionalProperties: false
            required:
            - entity_ids
            - entity_type
            properties:
              entity_ids:
                type: array
                description: Filter by entity IDs.
                items:
                  type: string
                examples:
                - - '123'
                  - '456'
              entity_type:
                type: string
                description: Filter by entity type. Use the most specific type needed, or the parent type with `include_child_entities` to widen scope.
                examples:
                - AD
                enum:
                - AD
                - AD_GROUP
                - CAMPAIGN
              include_child_entities:
                type: boolean
                description: Whether to include nested entities. Defaults to `false`.
        entity_field_filters:
          type: array
          title: EntityFieldFilters
          deprecated: true
          description: This filter is deprecated and no longer used for history filtering. It is ignored if provided. Use `change_types` to filter history by entity field changes.
          items:
            type: object
            title: EntityFieldFilter
            additionalProperties: false
            required:
            - entity_fields
            - entity_type
            properties:
              entity_fields:
                type: array
                description: Filter by entity fields.
                items:
                  type: string
                examples:
                - - id
                  - name
                  - configured_status
              entity_type:
                type: string
                description: Filter by entity type. Use the most specific type needed, or the parent type with `include_child_entities` to widen scope.
                examples:
                - AD
                enum:
                - AD
                - AD_ACCOUNT
                - AD_GROUP
                - AUDIENCE
                - CAMPAIGN
        entity_name_filters:
          type: array
          title: EntityNameFilters
          description: Expanded name filters for specific campaigns, ad groups, or ads.
          items:
            type: object
            title: EntityNameFilter
            additionalProperties: false
            required:
            - entity_names
            - entity_type
            - operator
            properties:
              entity_names:
                type: array
                description: Filter by entity names.
                items:
                  type: string
                examples:
                - - Ad 1
                  - Ad 2
              entity_type:
                type: string
                description: Filter by entity type.
                examples:
                - AD
                enum:
                - AD
                - AD_GROUP
                - CAMPAIGN
              operator:
                type: string
                description: The operator to filter on.
                examples:
                - LIKE
                enum:
                - EQUALS
                - LIKE
              include_child_entities:
                type: boolean
                description: Whether to include nested entities. Defaults to `false`.
    components_errors_404:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Member ID not found
            code:
              type: integer
              description: The error code.
              examples:
              - 404
    components_errors_429:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 429
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Too Many Requests
    components_errors_400:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 400
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Bad request.
            fields:
              title: FieldsList
              type: array
              items:
                type: object
                required:
                - field
                - message
                additionalProperties: false
                properties:
                  field:
                    title: FieldName
                    type: string
                    description: The field that caused the error.
                    examples:
                    - field_name
                  message:
                    type: string
                    description: A human friendly error message.
                    examples:
                    - Invalid value.
              description: The fields that caused the error.
    components_schema_ad_account_history:
      type: object
      title: AdAccountHistory
      additionalProperties: false
      properties:
        cause:
          type: object
          description: Details on the user who made the change.
          additionalProperties: false
          properties:
            member_id:
              type:
              - string
              - 'null'
              description: The member's member ID.
              examples:
              - t2_123456
              pattern: ^t2_.*
            reddit_username:
              type:
              - string
              - 'null'
              description: The member's Reddit username.
              examples:
              - reddit_user
            email:
              type:
              - string
              - 'null'
              description: The member's email address.
              examples:
              - john.snoo@reddit.com
            fullname:
              type:
              - string
              - 'null'
              description: The member's full name.
              examples:
              - John Snoo
            partner_business_name:
              type:
              - string
              - 'null'
              description: The name of the [partner business](https://business.reddithelp.com/s/article/partner-sharing) the user belongs to, if any.
              examples:
              - Acme Corporation
            changed_at:
              type: string
              description: When the change happened.
              examples:
              - '2023-11-20T03:00:00Z'
              format: date-time
        change:
          type: object
          description: Details on the change that was made.
          additionalProperties: false
          properties:
            after_value:
              type:
              - string
              - 'null'
              description: The value after the change.
              examples:
              - new_value
            before_value:
              type:
              - string
              - 'null'
              description: The value before the change.
              examples:
              - old_value
            entity_id:
              type: string
              description: The changed entity's ID.
              examples:
              - '1234567890'
            entity_name:
              type:
              - string
              - 'null'
              description: The changed entity's name.
              examples:
              - Campaign Name
            entity_type:
              type: string
              description: The changed entity's type.
              examples:
              - CAMPAIGN
              enum:
              - AD_ACCOUNT
              - AD
              - AD_GROUP
              - AUDIENCE
              - CAMPAIGN
            field_name:
              type: string
              description: The changed field's name.
              examples:
              - name
    components_schema_pagination_with_details:
      type: object
      additionalProperties: false
      properties:
        next_url:
          description: 'The full URL for the next page. If not available, the current page is the final page.

            > **Important:** The URL should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs.

            '
          example: https://ads-api.reddit.com/api/v3?page.token=nextToken
          type:
          - string
          - 'null'
          readOnly: true
        previous_url:
          description: 'The full URL for the previous page. If not available, the current page is the first page.

            > **Important:** The URL should be followed directly. Don''t assume pagination based on the query parameters in the provided URLs.

            '
          example: https://ads-api.reddit.com/api/v3?page.token=previousToken
          type:
          - string
          - 'null'
          readOnly: true
        page_index:
          type:
          - integer
          - 'null'
          description: The index of the current page.
          examples:
          - 0
          readOnly: true
        total_count:
          type:
          - integer
          - 'null'
          description: The total number of items across all pages.
          examples:
          - 150
          readOnly: true
    components_errors_403:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Access not granted for listing profiles.
            code:
              type: integer
              description: The error code.
              examples:
              - 403
    components_errors_500:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            code:
              type: integer
              description: The error code.
              examples:
              - 500
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Internal Server Error
    components_errors_401:
      type: object
      required:
      - error
      additionalProperties: false
      properties:
        error:
          type: object
          required:
          - message
          additionalProperties: false
          properties:
            message:
              type: string
              description: A human friendly error message.
              examples:
              - Bad bearer token provided.
            code:
              type: integer
              description: The error code.
              examples:
              - 401
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_400'
    NotFound:
      description: The specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_404'
    Unauthorized:
      description: No bearer token or a bad bearer token was provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_401'
    TooManyRequests:
      description: Too many requests. See [Rate Limiting](/docs/v3/guides/quick-start/rate-limiting) for header details and best practices.
      headers:
        RateLimit-Policy:
          description: The rate limit policies that apply to this request (IETF "RateLimit header fields for HTTP" draft). Each comma-separated policy is keyed by a public policy name and lists its quota `q` and window in seconds `w`.
          schema:
            type: string
            examples:
            - '"custom-audience-ingestion";q=3000;w=900,"custom-audience-ingestion-burst";q=500;w=60'
        RateLimit:
          description: 'The current rate limit state for each applicable policy (IETF "RateLimit header fields for HTTP" draft): remaining quota `r` and seconds until the window resets `t`. On a 429 the exhausted policy reports `r=0`.'
          schema:
            type: string
            examples:
            - '"custom-audience-ingestion";r=0;t=42,"custom-audience-ingestion-burst";r=0;t=5'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_429'
    ServerError:
      description: Server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_500'
    Forbidden:
      description: Insufficient authentication scopes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/components_errors_403'
  parameters:
    components_parameters_page_token:
      description: The token for the page to retrieve.
      in: query
      name: page.token
      schema:
        type: string
    components_parameters_page_size:
      description: The number of items to be returned by page.
      in: query
      name: page.size
      allowEmptyValue: true
      schema:
        type: integer
        maximum: 1000
  securitySchemes:
    RedditAPIKey:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.reddit.com/api/v1/authorize
          refreshUrl: https://www.reddit.com/api/v1/access_token
          tokenUrl: https://www.reddit.com/api/v1/access_token
          scopes:
            adsconversions: Post conversion events through the API
            adsread: Read advertising data through my account.
            adsedit: Write advertising data through my account.
            adsdatadeletion: Delete advertising data through my account.
      description: Reddit OAuth2 Security Key