Feature request - get Custom Fields from Experiment object

[evertonjuniti]

Within the Growthbook UI, we can create Custom Fields and use them within Experiments.

With the current Growthbook C# release, we can't get those custom fields if we add then through the UI.

So I'm asking the addition of this feature, to be possible to use Custom Fields within Experiments when getting experiment fields using the SDK.

[vazarkevych]

Hi @evertonjuniti . Please let us check that and we will write to you.

[vazarkevych]

Hi @evertonjuniti! Thanks for reporting this.

Before we can add support for Custom Fields in the C# SDK, we need to confirm whether these fields are included in the API payload for experiments.

Could you please check the JSON response returned from your GrowthBook API and see if the experiment objects contain a customFields (or similarly named) property?
If possible, sharing a small sanitized snippet would be very helpful.

This information is important because:

• If the API already returns these fields, we can extend the Experiment model and deserialize them in the C# SDK.

• If the API does not return them yet, then the functionality would need to be added at the backend level first.

Thanks a lot for your help — it will allow us to move forward with the SDK update more accurately.

[evertonjuniti]

Hi @vazarkevych , here's a small sanitized snippet that the core Growhtbook API returns when calling the experiment route:

{
"experiment": {
"id": "aaaaa",
"trackingKey": "key",
"name": "Test experiment",
"type": "standard",
"project": "zzzz",
"hypothesis": "",
"description": "",
"tags": [],
"owner": "wwww",
"dateCreated": "yyyy",
"dateUpdated": "xxxx",
"archived": false,
"status": "running",
"autoRefresh": true,
"hashAttribute": "id",
"fallbackAttribute": "",
"hashVersion": 2,
"disableStickyBucketing": false,
"bucketVersion": 1,
"minBucketVersion": 0,
"variations": [],
"phases": [],
"settings": {},
"shareLevel": "organization",
"linkedFeatures": [],
"hasVisualChangesets": false,
"hasURLRedirects": false,
"customFields": {
"cfl_4bzy5k3zmcjet8q5": "My custom field xyz"
},
"enchancedStatus": {}
}
}

The Custom Fields are one of the latest attributes, in the given example I have only one Custom Attribute, but we could have more, this specific attribute is not an array.

[evertonjuniti]

Additionally, when calling the v1/custom-fields route, you can get other attributes for each of them, like the name of it, type and possible values.

I think it would be nice if the SDK could handle the customFields from the experiment route but parse them into a record/class which the attributes are: Id, Name, Type, Section (where it could be used, it could be on features or experiments), Values (possible values for the custom field, if it is an enum for example), Active (boolean), Required (boolean).

Here's an example of the payload when calling the v1/custom-fields API from Growthbook:

{
"Id": "example",
"name": "Example Custom Field",
"type": "enum",
"section": "experiment",
"values": "OptionA,OptionB,OptionC",
"dateCreated": "xxxx",
"dateUpdated": "yyyy",
"active": true,
"required": false,
"projects": []
}

[vazarkevych]

Hi @evertonjuniti,

We've prepared a PR to add Custom Fields support.
Could you please review it and let us know if it works for you?

Thanks!