Pinterest Logs API

openapi: 3.0.3
info:
  version: 5.13.0
  title: Pinterest Logs API
  description: This is the description of your API.
  contact:
    name: Pinterest, Inc.
    url: https://developers.pinterest.com/
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://developers.pinterest.com/terms/
servers:
- url: https://api.pinterest.com/v5
tags:
- name: Logs
paths:
  /integrations/logs:
    post:
      summary: Receives batched logs from integration applications.
      description: 'This endpoint receives batched logs from integration applications on partner platforms.

        Note: If you''re interested in joining the beta, please reach out to your Pinterest account manager.'
      tags:
      - Logs
      operationId: integrations_logs/post
      x-ratelimit-category: ads_write
      security:
      - pinterest_oauth2:
        - ads:write
      x-sandbox: enabled
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationLogsRequest'
        description: Ingest log information from external integration application.
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationLogsSuccessResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailedError'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    IntegrationLogsRequest:
      type: object
      additionalProperties: false
      description: Batch of logs sent from an integration application.
      required:
      - logs
      properties:
        logs:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationLog'
    DetailedError:
      title: Detailed Error
      description: Used for including extra details to a base error
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: object
      required:
      - code
      - message
      - details
    IntegrationLogClientError:
      type: object
      additionalProperties: false
      description: System error details included in the log sent by the client.
      properties:
        cause:
          type: string
          description: Original cause of the error.
          maxLength: 512
        column_number:
          type: integer
          description: Column number in the line of the file that raised the error.
        file_name:
          type: string
          description: Filename where the error happened.
          maxLength: 256
        line_number:
          type: integer
          description: Line number where the error happened.
        message:
          type: string
          description: Human-readable description of the error.
          maxLength: 512
        message_detail:
          type: string
          description: More detail about the message.
          maxLength: 1024
        name:
          type: string
          description: Filename where the error happened.
          maxLength: 256
        number:
          type: integer
          description: Integer that specifies the error code.
        stack_trace:
          type: string
          description: Stack trace of where the error happened.
    IntegrationLogClientRequest:
      type: object
      additionalProperties: false
      description: HTTP request details included in the log sent by the client.
      required:
      - method
      - host
      - path
      properties:
        method:
          type: string
          enum:
          - GET
          - HEAD
          - POST
          - PUT
          - DELETE
          - CONNECT
          - OPTIONS
          - TRACE
          - PATCH
        host:
          type: string
          description: HTTP request host from host header.
        path:
          type: string
          description: HTTP request path.
        request_headers:
          type: object
          description: HTTP request headers as key-value pairs.
          additionalProperties:
            type: string
        response_headers:
          type: object
          description: HTTP response headers as key-value pairs.
          additionalProperties:
            type: string
        response_status_code:
          type: integer
    Error:
      title: Error
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
      required:
      - code
      - message
    IntegrationLog:
      type: object
      additionalProperties: false
      description: Schema for log sent from an integration application.
      required:
      - client_timestamp
      - event_type
      - log_level
      properties:
        client_timestamp:
          type: integer
          description: Timestamp in milliseconds of when the log was executed at the client.
        event_type:
          type: string
          enum:
          - APP
          - API
          description: Log event type
        log_level:
          type: string
          enum:
          - INFO
          - WARN
          - ERROR
          description: Log level type
        external_business_id:
          type: string
          maxLength: 2048
          nullable: true
        advertiser_id:
          type: string
          maxLength: 128
          nullable: true
        merchant_id:
          type: string
          maxLength: 128
          nullable: true
        tag_id:
          type: string
          maxLength: 128
          nullable: true
        feed_profile_id:
          type: string
          maxLength: 128
          nullable: true
        message:
          type: string
          description: Explanation of the event that occured.
          maxLength: 2048
        app_version_number:
          type: string
          description: Version number of the integration application.
          maxLength: 20
        platform_version_number:
          type: string
          description: Version number of the platform the integration application is running on.
          maxLength: 20
        error:
          $ref: '#/components/schemas/IntegrationLogClientError'
        request:
          $ref: '#/components/schemas/IntegrationLogClientRequest'
    IntegrationLogsSuccessResponse:
      description: Response when logs are successfully processed.
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    pinterest_oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.pinterest.com/oauth/
          tokenUrl: https://api.pinterest.com/v5/oauth/token
          scopes:
            ads:read: See all of your advertising data, including ads, ad groups, campaigns etc.
            ads:write: Create, update, or delete ads, ad groups, campaigns etc.
            billing:read: See all of your billing data, billing profile, etc.
            billing:write: Create, update, or delete billing data, billing profiles, etc.
            biz_access:read: See business access data
            biz_access:write: Create, update, or delete business access data
            boards:read: See your public boards, including group boards you join
            boards:read_secret: See your secret boards
            boards:write: Create, update, or delete your public boards
            boards:write_secret: Create, update, or delete your secret boards
            catalogs:read: See all of your catalogs data
            catalogs:write: Create, update, or delete your catalogs data
            pins:read: See your public Pins
            pins:read_secret: See your secret Pins
            pins:write: Create, update, or delete your public Pins
            pins:write_secret: Create, update, or delete your secret Pins
            user_accounts:read: See your user accounts and followers
            user_accounts:write: Update your user accounts and followers
    conversion_token:
      type: http
      scheme: bearer
      description: This security scheme only applies to the conversion events endpoint (POST /ad_accounts/{ad_account_id}/events). This endpoint requires a bearer token generated via Ads Manager (ads.pinterest.com).
    basic:
      type: http
      scheme: basic
x-tagGroups:
- name: Pin and Boards
  tags:
  - pins
  - boards
  - media
  - aggregated_comments
  - aggregated_pin_data
  - user_account
- name: Campaign Management
  tags:
  - ad_accounts
  - campaigns
  - ad_groups
  - ads
  - product_group_promotions
  - bulk
- name: Targeting
  tags:
  - audiences
  - customer_lists
  - keywords
  - targeting_template
  - audience_insights
  - audience_sharing
- name: Ad Formats
  tags:
  - lead_forms
  - lead_ads
  - leads_export
- name: Billing
  tags:
  - billing
  - order_lines
  - terms_of_service
- name: Business Access
  tags:
  - business_access_assets
  - business_access_invite
  - business_access_relationships
- name: Conversions
  tags:
  - conversion_events
  - conversion_tags
- name: Others
  tags:
  - integrations
  - oauth
  - resources
  - search
  - terms
- name: Shopping
  tags:
  - catalogs
- name: Deprecated
  tags:
  - product_groups