UserReadOut

  • data
    Type: object · UserRecord
    required
    • user_id
      Type: string · User Id
      min length:  
      1
      max length:  
      512
      required

      Unique identifier for a user who has signed in. user_id can be in any format (e.g. users' email, internal user UUID or serial ID). The only restriction is that the first character must not be an underline _. Miso will use this id to cross-reference your User records with your Interaction records.

    • age
      Type: integer · Age

      Age of the user. We will internally convert it to year of birth.

    • city
      Type: string · City

      City or zipcode the user is based in.

    • country
      Type: string · Country

      Country the user is based in.

    • created_at

      The date the user’s account was created as an ISO-8601 date or datetime string.

      • Type: string · Created AtFormat: date-time

        The date the user’s account was created as an ISO-8601 date or datetime string.

    • custom_attributes
      Type: object · Custom Attributes

      Dictionary of custom attributes about the user. As with the Product API, you can specify attributes specific to your business in a {"KEY" : VALUE} format, where KEY must be a string, and VALUE can be:

      • a string or an array of strings

      • a number or an array of numbers

      • an array of objects

      • a bool

      • null

      • Example:

      {
          "custom_attributes": {
              "acquisition_channel": "Facebook Campaign 2020",
              "declared_interests": ["Drama", "Romance"]
          }
      }
      

      These custom attributes types must be consistent across all User records in your data set. Records with inconsistent types will fail to be inserted.

    • description
      Type: string · Description

      Text description of the user. This can be the user's own bio or the internal notes about the user. If available, Miso will analyze this description to better profile a user.

    • gender
      Type: string · Gender

      The user's gender.

    • group_id
      Type: string · Group Id

      Group or Account ID from your CRM. This is useful in B2B scenarios. For example, you can use group_id to associate a user with their company or account. We will use this information to infer the user's interests and fine-tune their personalization and search results. For example, users from the same group might have similar interests on the site, and we can improve their user experience accordingly

    • name
      Type: string · Name

      The user's full name.

    • profile_image
      Type: string · Profile Image
      min length:  
      1
      max length:  
      65536
      Format: uri

      URL to the profile image of the user.

    • state
      Type: string · State

      State the user is based in.

    • updated_at

      The date the user’s account was updated as an ISO-8601 date or datetime string.

      • Type: string · Updated AtFormat: date-time

        The date the user’s account was updated as an ISO-8601 date or datetime string.

  • message
    Type: string · Message
    required

    Human-readable message