Oneprofile Attribution API

openapi: 3.2.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: Reference | Oneprofile Attribution API
  version: 1.0.42765316646
tags:
- description: 'Endpoints for recording where a new workspace came from: the marketing page or campaign its signup link carried, sent once after signup.'
  name: Attribution
paths:
  /attribution/signup-source/:
    put:
      description: 'Record the marketing page or campaign the caller''s workspace signed up from: the `src` tag and the `utm_source`, `utm_medium` and `utm_campaign` values the register link carried. The app sends it once, right after signup. First touch wins: a workspace keeps the first source recorded for it, and one that is no longer registering records nothing. Neither is an error; both report `recorded: false`. Requires a signed-in user rather than an API key: a signup has a person behind it.'
      operationId: claim_signup_source
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignupSourceClaimRequestSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupSourceClaimReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Workspace not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Record where a new workspace came from
      tags:
      - Attribution
  /attribution/signup/:
    put:
      description: 'Record that the signed-in person has signed up, so the team hears about it once. The app sends it right after signup. A person is announced at most once, and only within 24 hours of creating their account; anything else reports `recorded: false`. Requires a signed-in user rather than an API key: a signup has a person behind it.'
      operationId: record_signup
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupRecordReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: User not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Announce the caller's signup
      tags:
      - Attribution
components:
  schemas:
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
      - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - items: {}
            type: array
          - additionalProperties: true
            type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: The type of the error. Useful for frontend code to handle different types of errors.
          title: Type
          type: string
      required:
      - loc
      - msg
      - type
      - input
      title: UnprocessableEntityIssue
      type: object
    SignupSourceClaimReadSchema:
      description: 'The outcome of recording a signup source.


        Always 200 for a well formed body. A workspace that already has a source

        keeps it, and one that is no longer registering gets none: both report

        `recorded: false`, because neither is something to alarm a new user about.'
      properties:
        recorded:
          description: Whether this call recorded the source for the workspace.
          title: Recorded
          type: boolean
      required:
      - recorded
      title: SignupSourceClaimReadSchema
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
      - detail
      title: ServerErrorResponse
      type: object
    SignupSourceClaimRequestSchema:
      description: The source a new workspace's first link carried, sent once after signup.
      properties:
        src:
          anyOf:
          - maxLength: 100
            minLength: 1
            pattern: ^[a-z0-9-]+$
            type: string
          - type: 'null'
          description: The marketing site's own source tag from the register link's `src` parameter, `<lane>-<slug>[-<slot>]`, for example `blog-what-is-data-enrichment-moment`.
          title: Src
        utm_campaign:
          anyOf:
          - maxLength: 100
            minLength: 1
            pattern: ^[a-z0-9._-]+$
            type: string
          - type: 'null'
          description: The register link's `utm_campaign` parameter, if it had one.
          title: Utm Campaign
        utm_medium:
          anyOf:
          - maxLength: 100
            minLength: 1
            pattern: ^[a-z0-9._-]+$
            type: string
          - type: 'null'
          description: The register link's `utm_medium` parameter, if it had one.
          title: Utm Medium
        utm_source:
          anyOf:
          - maxLength: 100
            minLength: 1
            pattern: ^[a-z0-9._-]+$
            type: string
          - type: 'null'
          description: The register link's `utm_source` parameter, if it had one.
          title: Utm Source
      title: SignupSourceClaimRequestSchema
      type: object
    SignupRecordReadSchema:
      description: 'The outcome of announcing a signup.


        Always 200. A person who was already announced, or whose account is older

        than the registration window, reports `recorded: false`: neither is

        something to alarm a new user about.'
      properties:
        recorded:
          description: Whether this call announced the caller's signup.
          title: Recorded
          type: boolean
      required:
      - recorded
      title: SignupRecordReadSchema
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message.
          title: Detail
          type: string
        issues:
          description: The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
      - detail
      - issues
      title: UnprocessableEntityResponse
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
      - detail
      title: UnauthorizedResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
      - detail
      title: NotFoundResponse
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http