Model: CustomFieldsList

1 min

Model Parameters

CustomFieldsList
- countintegerrequired
  Example
  2
  Description
  Number of CustomFields on the current page.
- first_urlobjectrequired
  Description
  Link to first page of CustomFields in a series.
  - UrlValue
- itemsCustomField[]required
  Description
  Represents custom fields for entities
  - archivedboolean
    Description
    Whether the custom field is archived. New custom fields are created as unarchived by default.
  - created_by_user_idstring
    Example
    [email protected]
    Description
    Identifier of the user who created this custom field (often an email).
  - created_timestring<date-time>
    Example
    2024-01-01T10:00:00.000Z
    Description
    Timestamp when the custom field was created.
    Format
    date-time
  - default_valuestring
    Example
    option1
    Description
    Default value for the custom field if applicable.
  - descriptionstring
    Example
    Custom field to tag experiments owned by the analytics team
    Description
    Optional detailed description explaining the purpose and context of this CustomField. Helps team members understand what this CustomField is measuring.
    Max Length
    1000
  - entity_typestring<flag | rule>required
    Example
    flag
    Description
    Type of entity the custom field is associated with
    Allowed
    flagrule
  - field_typestring<text | number | boolean | link | label>required
    Example
    text
    Description
    The type of the custom field (e.g., text, number, boolean, link, label)
    Allowed
    textnumberbooleanlinklabel
  - idintegerrequired
    Example
    12345
    Description
    System-generated unique identifier for the CustomField.
  - keystringrequired
    Example
    analytics_team
    Description
    Unique user-defined identifier for the CustomField within the project. Must contain only alphanumeric characters, underscores, and hyphens.
    Max Length
    64
    Pattern
    ^[a-zA-Z0-9_\-]+$
  - namestringrequired
    Example
    Analytics Team
    Description
    Human-readable name for the CustomField displayed in the UI.
    Max Length
    255
  - project_idinteger<int64>
    Example
    98765
    Description
    The unique identifier of the project this CustomField belongs to.
    Format
    int64
  - requiredbooleanrequired
    Description
    Indicates if the custom field is required for the associated entity.
  - updated_timestring<date-time>
    Example
    2024-01-01T10:00:00.000Z
    Description
    Timestamp when the custom field was last updated.
    Format
    date-time
  - validationobject
    Example
    { "max": 100, "max_length": 255, "min": 1 }
    Description
    Validation rules for the custom field if applicable. Allowed keys depend on field_type:
    
    text → max_length, regex
    
    number → min, max, decimal_places, use_thousand_separator
    
    label → field_options, allow_multi_select
    
    link → no validation fields
    
    boolean → no validation fields
    - allow_multi_selectboolean
      Description
      Whether multiple values can be selected for label fields.
    - decimal_placesinteger
      Example
      2
      Description
      Number of allowed decimal places for numeric values.
    - field_optionsstring[]
      Example
      [ "US", "EU", "APAC" ]
      Description
      Allowed values for label fields.
    - maxnumber
      Example
      100
      Description
      Maximum value for number fields.
    - max_lengthinteger
      Example
      255
      Description
      Maximum length for string fields.
    - minnumber
      Example
      1
      Description
      Minimum value for number fields.
    - regexstring
      Example
      ^[A-Za-z0-9_-]+$
      Description
      Regular expression that the input must match.
    - use_thousand_separatorboolean
      Example
      true
      Description
      Whether thousand separators should be permitted/displayed.
- last_urlobjectrequired
  Description
  Link to the last page of CustomFields in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of CustomFields in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  5
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of CustomFields in a series.
  
  The first element in the array is the exact previous page before the current record, etc.
  - UrlList
- total_countintegerrequired
  Example
  20
  Description
  Total number of CustomFields for this series.
- total_pagesintegerrequired
  Example
  10
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue