openapi: 3.2.0
info:
  version: '2.2'
  title: Dynamic Yield Experience Profile Anywhere API
  description: API definitions for all Dynamic Yield public endpoints.
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/support
servers:
- url: https://dy-api.com/v2
  description: US data center
- url: https://direct.dy-api.com/v2
  description: US data center, direct endpoint
- url: https://dy-api.eu/v2
  description: EU data center
- url: https://direct.dy-api.eu/v2
  description: EU data center, direct endpoint
security:
- ApiKeyAuth: []
tags:
- name: Profile Anywhere
  description: Retrieve user affinity data.
paths:
  /userprofile:
    summary: Profile Anywhere
    get:
      summary: Profile Anywhere
      description: 'Retrieve user affinity data generated by Dynamic Yield, enabling you to offer enhanced personalized experiences to your customers across all your touchpoints, both online and offline.

        **Note:** Rate limit is 50 calls per second.

        **Support site article:** Profile Anywhere'
      operationId: profileAnywhere
      tags:
      - Profile Anywhere
      parameters:
      - $ref: '#/components/parameters/UserProfileCuid'
      - $ref: '#/components/parameters/UserProfileCuidType'
      - $ref: '#/components/parameters/UserProfileAffinity'
      responses:
        '200':
          $ref: '#/components/responses/ResultUserProfile'
components:
  parameters:
    UserProfileCuidType:
      name: cuidType
      description: Use `he` for hashed email addresses or use your custom identifier type.
      in: query
      required: true
      schema:
        type: string
      examples:
        HashedEmail:
          value: he
        ExternalIdentifier:
          value: external
        CustomIdentifier:
          value: vipclub
    UserProfileCuid:
      name: cuid
      description: The user's unique identifier.
      in: query
      required: true
      schema:
        type: string
      example: '13510582476552222'
    UserProfileAffinity:
      name: affinity
      description: Whether to receive affinity data for the user.
      in: query
      required: true
      schema:
        type: boolean
      example: true
  responses:
    ResultUserProfile:
      description: Result
      content:
        application/json:
          schema:
            type: object
            properties:
              affinity:
                description: Affinity scoring grouped by profile dimensions.
                type: object
                example:
                  color:
                    Black: 1
                    White: 2
                    Red: 3
                  categories:
                    Men: 1
                    Flats: 2
                    Shoes: 3
                    Trainers: 4
                    Sneakers: 5
  securitySchemes:
    ApiKeyAuth:
      description: Your API key
      type: apiKey
      in: header
      name: dy-api-key
      x-default: your-api-key
x-provenance:
  method: searched
  source: https://dy.dev/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://dy.dev/reference/browse.md
  - https://dy.dev/reference/choose-variations.md
  - https://dy.dev/reference/externalevents.md
  - https://dy.dev/reference/profileanywhere.md
  - https://dy.dev/reference/reportoutages.md
  - https://dy.dev/reference/search.md
  - https://dy.dev/reference/shoppingmuse.md
  - https://dy.dev/reference/suggest.md
  - https://dy.dev/reference/track-engagement.md
  - https://dy.dev/reference/track-pageviews.md
  - https://dy.dev/reference/trackevents.md
  - https://dy.dev/reference/tracktransactionstatusspecificitem.md
  - https://dy.dev/reference/tracktransactionstatuswholetransaction.md
  - https://dy.dev/reference/update-reconnect-opt-in.md
  - https://dy.dev/reference/update-reconnect-opt-out.md
  - https://dy.dev/reference/updateaddonsfeed.md
  - https://dy.dev/reference/updatebranchfeed.md
  - https://dy.dev/reference/updateproductfeed.md
  - https://dy.dev/reference/userdataapi.md
  merge:
    pages: 19
    deduped: 262
    conflicts_kept_first: 0