Mavrck Global User API

openapi: 3.2.0
info:
  version: 1.0.0
  description: Identify your most influential customers and activate them to drive more conversions on social.
  title: MAVRCK.IO Global User API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: GlobalUser
paths:
  /v1/global-users/me:
    get:
      operationId: retrieveCurrentUser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCurrentUserResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
  /v1/global-users/{id}:
    get:
      operationId: get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGlobalUserResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      - in: query
        name: index
        required: false
        schema:
          type: string
          enum:
          - user_index
          - members_index
      - in: query
        name: isPublic
        required: false
        schema:
          type: boolean
    put:
      operationId: updateGlobalUserSummary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      description: Update an Influencer Index creator's contact info.
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGlobalUserBodyDefinition'
        required: true
  /v1/global-users:
    get:
      operationId: getGlobalUsers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGlobalUsersResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '422':
          description: Unprocessable Content, Invalid Query Parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableContent'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      description: 'This endpoint point is also used by other microservices ike export-service

        retrieveIds is a boolean, see https://github.com/latermedia/export-service/blob/0bf2bf7ab022e718697872cd9de5a6fe05aab2fb/worker/src/main/kotlin/co/mavrck/exportservice/worker/Sapi.kt#L71

        globalUserIds in queryParams is a string: "3704000,13704570,13704663", but it''s used as an array of number in the code'
      tags:
      - GlobalUser
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: useSearchWithOpenAI
        required: false
        schema:
          type: boolean
      - in: query
        name: retrieveIds
        required: false
        schema:
          type: boolean
      - in: query
        name: globalUserIds
        required: false
        schema:
          type: string
      - in: query
        name: prompt
        required: false
        schema:
          type: string
    put:
      operationId: addNewInfluencer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  action:
                    $ref: '#/components/schemas/GlobalUserUpsertAction'
                  globalUserId:
                    type:
                    - number
                    - 'null'
                    format: double
                required:
                - action
                - globalUserId
                type: object
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      description: 'Add a new creator using CDS-first lookup.

        Returns the global user ID and action (CREATED or CONFLICT) if the creator was added successfully.

        Returns an error if the creator could not be added.'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGlobalUserBodyDefinition'
        required: true
  /v1/global-users/preview:
    put:
      operationId: previewAddCreator
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  movingTo:
                    type: string
                    enum:
                    - index
                    - members
                    - both
                  message:
                    type: string
                  preview:
                    type: boolean
                  globalUserId:
                    type:
                    - number
                    - 'null'
                    format: double
                  action:
                    $ref: '#/components/schemas/GlobalUserUpsertAction'
                required:
                - preview
                - globalUserId
                - action
                type: object
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      description: 'Preview CDS-first creator lookup without side effects.

        Returns what action would be taken if the creator were to be added.'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGlobalUserBodyDefinition'
        required: true
  /v1/global-users/{globalUserId}/audience-demographics/latest:
    post:
      operationId: refreshAudienceDemographics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                additionalProperties: true
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshAudienceDemographicsBody'
        required: true
  /v1/global-users/{globalUserId}/audience-demographics:
    get:
      operationId: getAudienceDemographics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalUserAudienceDemographicsResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/public-users:
    post:
      operationId: markPublic
      responses:
        '200':
          description: OK
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
    delete:
      operationId: markPrivate
      responses:
        '200':
          description: OK
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/creator-refresh:
    post:
      operationId: enqueueCreatorRefresh
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  previewPostsLastUpdatedAt:
                    type:
                    - string
                    - 'null'
                    format: date-time
                  recentlyAnalyzed:
                    type: boolean
                  lastRefreshedAt:
                    type:
                    - string
                    - 'null'
                    format: date-time
                required:
                - previewPostsLastUpdatedAt
                - recentlyAnalyzed
                - lastRefreshedAt
                type: object
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/brand-safety-request:
    post:
      operationId: makeBrandSafetyRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandSafetyRequestReponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/brand-suitability:
    get:
      operationId: getBrandSuitabilityReport
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBrandSuitabilityReportResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
      - in: query
        name: campaignId
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: brandName
        required: false
        schema:
          type: string
    post:
      operationId: generateBrandSuitabilityReport
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateBrandSuitabilityReportResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateBrandSuitabilityReportRequest'
        required: true
  /v1/global-users/all-social-profiles:
    post:
      operationId: getAllSocialProfiles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalUserSearchAllSocialProfilesByIdsPostResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalUserSearchAllSocialProfilesByIdsPostParams'
        required: true
  /v1/global-users/inconsistencies:
    post:
      operationId: getInconsistencies
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalUserGetInconsistenciesPostResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalUserGetInconsistenciesPostParams'
        required: true
  /v1/global-users/repair:
    post:
      operationId: repair
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalUserRepairPostResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalUserRepairPostParams'
        required: true
  /v1/global-users/random/guids:
    get:
      operationId: getRandomGlobalUsers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalUserGetRandomGlobalUsersResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/mark-as-non-contactable:
    post:
      operationId: markAsNonContactable
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing or invalid parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/delete-public-summary-record:
    post:
      operationId: deletePublicSummaryRecord
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing or invalid parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/{globalUserId}/audience-countries:
    get:
      operationId: getGlobalUserAudienceCountries
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalUserAudienceCountriesQueryResult'
        '400':
          description: Missing or invalid parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Global user not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
      - in: query
        name: orderDirection
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - in: query
        name: orderProperty
        required: false
        schema:
          type: string
          enum:
          - percentage
          - country
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
  /v1/global-users/import-influencers:
    post:
      operationId: importInfluencers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing or invalid parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportInfluencerBody'
        required: true
  /v1/global-users/{globalUserId}/content:
    post:
      operationId: fetchContent
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ContentPost'
                type: array
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      deprecated: true
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
      - in: query
        name: socialNetwork
        required: true
        schema:
          type: string
      - in: query
        name: discover
        required: false
        schema:
          type: boolean
  /v1/global-users/{globalUserId}/reindex:
    post:
      operationId: reindexUser
      responses:
        '200':
          description: OK
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      parameters:
      - in: path
        name: globalUserId
        required: true
        schema:
          type: number
          format: double
  /v1/global-users/bulk-actions:
    post:
      operationId: bulkActions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    additionalProperties: true
                  action:
                    type: string
                    enum:
                    - reindex
                    - refreshAudienceDemographics
                required:
                - result
                - action
                type: object
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - GlobalUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActionsBody'
        required: true
  /v1/global-users-total:
    get:
      operationId: getQueryTotal
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                - meta
                type: object
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components

# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-globaluser-api-openapi.yml