MadHive Pixel API

openapi: 3.2.0
info:
  title: Madhive Pixel API
  version: 1.0.0
  description: "The Madhive API provides a comprehensive interface for digital advertising clients and services.\n\n## Authentication\nThis API uses OAuth 2.0 client credentials flow for authentication. To access protected endpoints:\n\n1. **Obtain an access token** using the `/oauth/token` endpoint with your client credentials\n2. **Include the token** in subsequent API requests using the `Authorization` header:\n   ```\n   Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\n   ```\n\n### Token Usage Example\n```bash\n# Get access token\ncurl -X POST \"https://api2.madhive.com/oauth/token\" \\\n  -H \"Content-Type: application/x-www-form-urlencoded\" \\\n  -d \"grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET\"\n\n# Use token in API requests\ncurl -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" \\\n  \"https://api2.madhive.com/v1/campaigns\"\n```\n\n**Note:** Access tokens have an expiration time. You should handle token refresh in your application logic.\n"
servers:
- url: https://api2.madhive.com/api
  description: apigee
tags:
- name: pixel
paths:
  /v1/pixels/{id}:
    put:
      tags:
      - pixel
      summary: Updating a tracking pixel
      description: Updating a tracking pixel
      operationId: updatePixel
      parameters:
      - name: id
        in: path
        description: pixel id
        required: true
        x-oapi-codegen-extra-tags:
          validate: required,min=28,max=28
        schema:
          type: string
      - $ref: '#/components/parameters/X-Cloud-Trace-Context'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PixelRequest'
        description: pixel update
        required: true
      responses:
        '200':
          description: pixel updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixelResponse'
              examples:
                response:
                  value:
                    id: dvxol3J56P8YDMsGEGStu7rCRaYE
                    name: my updated pixel
                    advertiserId: fwpObxzCpvITV2GspiUc3C5YfprJ
                    status: READY
                    urlPixel: https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi
                    jsPixel: <script>!function(e){e=document.createElement("img");e.src="https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi"</script>
                    htmlPixel: '<img src="https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi" style="display: none;" width="0" height="0">'
                    transaction:
                      id: 4af459ff8e1a36b6bb74fb88f1a02477
                      created: '2030-11-02T15:04:00Z'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    error: 'name: cannot be empty'
                    status: ERROR
                    transaction:
                      id: 4af459ff8e1a36b6bb74fb88f1a02477
                      taskId: '14158884487309867565'
        '401':
          $ref: '#/components/responses/401Unauthorized'
      security:
      - oauth2: []
  /v1/pixels:
    post:
      tags:
      - pixel
      summary: Creating a tracking pixel
      description: Creating a tracking pixel
      operationId: createPixel
      parameters:
      - $ref: '#/components/parameters/X-Cloud-Trace-Context'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PixelRequest'
        description: pixel creation
        required: true
      responses:
        '200':
          description: pixel created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixelResponse'
              examples:
                response:
                  value:
                    id: dvxol3J56P8YDMsGEGStu7rCRaYE
                    name: my first pixel
                    advertiserId: fwpObxzCpvITV2GspiUc3C5YfprJ
                    status: READY
                    urlPixel: https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi
                    jsPixel: <script>!function(e){e=document.createElement("img");e.src="https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi"</script>
                    htmlPixel: '<img src="https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi" style="display: none;" width="0" height="0">'
                    transaction:
                      id: 4af459ff8e1a36b6bb74fb88f1a02477
                      created: '2030-11-02T15:04:00Z'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    error: 'name: cannot be empty'
                    status: ERROR
                    transaction:
                      id: 4af459ff8e1a36b6bb74fb88f1a02477
                      taskId: '14158884487309867565'
        '401':
          $ref: '#/components/responses/401Unauthorized'
      security:
      - oauth2: []
components:
  schemas:
    Pixel:
      type: object
      required:
      - name
      - advertiserId
      properties:
        id:
          type: string
          x-go-type-skip-optional-pointer: true
          x-oapi-codegen-extra-tags:
            validate: required_with=Status,omitempty,min=28,max=28
          description: madhive pixel id
          example: dvxol3J56P8YDMsGEGStu7rCRaYE
        name:
          type: string
          x-oapi-codegen-extra-tags:
            validate: 'required,min=2,ne= '
          x-isnullable: false
          x-omitempty: false
          description: pixel name
          example: my first pixel
        advertiserId:
          type: string
          x-isnullable: false
          x-omitempty: false
          x-oapi-codegen-extra-tags:
            validate: required,min=28,max=28
          description: advertiser id
          example: fwpObxzCpvITV2GspiUc3C5YfprJ
        urlPixel:
          type: string
          x-go-type-skip-optional-pointer: true
          x-isnullable: false
          x-omitempty: true
          description: url pixel
          example: https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi
        jsPixel:
          type: string
          x-go-type-skip-optional-pointer: true
          x-isnullable: false
          x-omitempty: true
          description: js pixel
          example: <script>!function(e){e=document.createElement("img");e.src="https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi"</script>
        htmlPixel:
          type: string
          x-go-type-skip-optional-pointer: true
          x-isnullable: false
          x-omitempty: true
          description: html pixel
          example: '<img src="https://jelly.mdhv.io/v1/star.gif?pid=EfwNWX7NdVGxE7pcT5mTte92PxIN&src=mh&evt=hi" style="display: none;" width="0" height="0">'
    PixelRequest:
      type: object
      required:
      - name
      - advertiserId
      properties:
        name:
          type: string
          x-oapi-codegen-extra-tags:
            validate: 'required,min=2,ne= '
          x-isnullable: false
          x-omitempty: false
          description: pixel name
          example: my first pixel
        advertiserId:
          type: string
          x-isnullable: false
          x-omitempty: false
          x-oapi-codegen-extra-tags:
            validate: required,min=28,max=28
          description: advertiser id
          example: fwpObxzCpvITV2GspiUc3C5YfprJ
    ErrorResponse:
      type: object
      required:
      - transaction
      properties:
        errors:
          type: array
          x-go-type-skip-optional-pointer: true
          items:
            type: string
          description: many error messages
        error:
          type: string
          x-go-type-skip-optional-pointer: true
          description: error message
          example: Unauthorized
        status:
          type: string
          x-go-type-skip-optional-pointer: true
          description: status of the service
          example: ERROR
        transaction:
          $ref: '#/components/schemas/Transaction'
    PixelResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/Pixel'
      - type: object
        required:
        - transaction
        - status
        properties:
          transaction:
            $ref: '#/components/schemas/Transaction'
          status:
            $ref: '#/components/schemas/Status'
    Transaction:
      type: object
      x-go-type-skip-optional-pointer: true
      x-omitempty: false
      required:
      - id
      - taskId
      - created
      properties:
        id:
          type: string
          description: trace id
          example: 4af459ff8e1a36b6bb74fb88f1a02477
        taskId:
          type: string
          x-omitempty: true
          description: task id
          example: '14158884487309867565'
        created:
          type: string
          description: 'order created date, format: yyyy-mm-dd hh:mm:ss'
          example: '2030-11-02T15:04:00Z'
    Status:
      type: string
      x-isnullable: false
      x-omitempty: false
      x-oapi-codegen-extra-tags:
        validate: omitempty,oneof=READY ARCHIVED CANCELLED DRAFT PAUSED
      description: status of the entity
      example: READY
      enum:
      - READY
      - ARCHIVED
      - CANCELLED
      - DRAFT
      - PAUSED
  parameters:
    X-Cloud-Trace-Context:
      name: X-Cloud-Trace-Context
      in: header
      description: gcp trace
      required: false
      schema:
        type: string
        default: 91f9f012dc7c7ffc13604c77f12a8931
  examples:
    401Ex:
      value:
        error: unauthorized
        status: ERROR
        transaction:
          id: 4af459ff8e1a36b6bb74fb88f1a02477
          taskId: '14158884487309867565'
          created: '2030-11-02T15:04:00Z'
  responses:
    401Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            response:
              $ref: '#/components/examples/401Ex'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api2.madhive.com/oauth/token
          scopes: {}
    basicAuth:
      type: http
      description: Basic Authentication Not Implemented
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header
      description: jwt access token for authentication