> For the complete documentation index, see [llms.txt](https://docs.mediarithmics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mediarithmics.io/api-reference/datamart-management/user-defined-segment-metrics.md).

# User Defined Segment Metrics

Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels.

## GET /datamarts/{datamart\_id}/audience\_segment\_identifiers\_metrics

> Search for audience segment identifiers metrics

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"User Defined Segment Metrics","description":"Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/audience_segment_identifiers_metrics":{"get":{"parameters":[{"style":"simple","schema":{"type":"string"},"in":"path","name":"datamart_id","required":true,"explode":false},{"name":"status","style":"form","required":false,"in":"query","explode":true,"schema":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricStatus"}},{"required":false,"style":"form","in":"query","explode":true,"schema":{"type":"boolean"},"description":"Retrieve archived audience segment identifiers metrics","name":"archived"},{"required":false,"style":"form","name":"order_by","in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"required":false,"schema":{"type":"integer","format":"int32"},"description":"Offset from which the search must be performed","in":"query","explode":true,"style":"form","name":"first_result"},{"style":"form","in":"query","schema":{"type":"integer","format":"int32"},"description":"Maximum number of items that may be returned by the query","required":false,"name":"max_results","explode":true}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}},"max_results":{"type":"integer"},"total":{"type":"integer"},"status":{"type":"string","enum":["ok"]},"count":{"type":"integer"},"first_result":{"type":"integer"}},"required":["count","data","first_result","max_results","status","total"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"tags":["User Defined Segment Metrics"],"summary":"Search for audience segment identifiers metrics","operationId":"findAudienceSegmentIdentifiersMetrics","description":""}}},"components":{"schemas":{"AudienceSegmentIdentifiersMetricStatus":{"type":"string","enum":["INACTIVE","ACTIVE"],"readOnly":false},"AudienceSegmentIdentifiersMetricResource":{"type":"object","properties":{"order_index":{"type":"integer","format":"int32","default":0,"readOnly":false},"last_modified_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_by":{"type":"string","readOnly":true},"last_modified_by":{"type":"string","readOnly":true},"metric_definition":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDefinitionResource"},"archived":{"type":"boolean","default":false,"readOnly":false},"status":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricStatus"},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":true},"display":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDisplayResource"}},"required":["archived","created_by","created_ts","datamart_id","display","id","metric_definition","order_index","status"]},"AudienceSegmentIdentifiersMetricDefinitionResource":{"discriminator":{"propertyName":"type","mapping":{"USER_ACCOUNT":"#/components/schemas/UserAccountMetricDefinitionResource","QUERY":"#/components/schemas/QueryMetricDefinitionResource","USER_POINT":"#/components/schemas/UserPointMetricDefinitionResource","USER_DEVICE_POINT":"#/components/schemas/UserDevicePointMetricDefinitionResource","USER_PROFILE":"#/components/schemas/UserProfileMetricDefinitionResource","USER_DEVICE_TECHNICAL_ID":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource","USER_EMAIL":"#/components/schemas/UserEmailMetricDefinitionResource"}},"oneOf":[{"$ref":"#/components/schemas/UserDevicePointMetricDefinitionResource"},{"$ref":"#/components/schemas/QueryMetricDefinitionResource"},{"$ref":"#/components/schemas/UserEmailMetricDefinitionResource"},{"$ref":"#/components/schemas/UserAccountMetricDefinitionResource"},{"$ref":"#/components/schemas/UserProfileMetricDefinitionResource"},{"$ref":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource"},{"$ref":"#/components/schemas/UserPointMetricDefinitionResource"}],"properties":{"type":{"type":"string","enum":["USER_DEVICE_POINT","QUERY","USER_EMAIL","USER_ACCOUNT","USER_PROFILE","USER_DEVICE_TECHNICAL_ID","USER_POINT"]}},"required":["type"]},"UserDevicePointMetricDefinitionResource":{"type":"object"},"QueryMetricDefinitionResource":{"type":"object","properties":{"query_id":{"type":"string","readOnly":false}},"required":["query_id"]},"UserEmailMetricDefinitionResource":{"type":"object"},"UserAccountMetricDefinitionResource":{"type":"object","properties":{"compartment_type":{"$ref":"#/components/schemas/UserAccountCompartmentType"},"compartment_id":{"type":"string","readOnly":false}},"required":["compartment_type"]},"UserAccountCompartmentType":{"type":"string","enum":["CUSTOM_COMPARTMENT_ID","NETWORK_USER_ID"],"readOnly":false},"UserProfileMetricDefinitionResource":{"type":"object","properties":{"compartment_id":{"type":"string","readOnly":false}}},"UserDeviceTechnicalIdMetricDefinitionResource":{"type":"object","properties":{"registry_type":{"$ref":"#/components/schemas/DeviceIdRegistryType"},"registry_id":{"type":"string","readOnly":false}},"required":["registry_type"]},"DeviceIdRegistryType":{"type":"string","enum":["INSTALLATION_ID","MUM_ID","NETWORK_DEVICE_ID","CUSTOM_DEVICE_ID","MOBILE_ADVERTISING_ID","MOBILE_VENDOR_ID","TV_ADVERTISING_ID","IP_V4_ADDRESS_ID","IP_V6_ADDRESS_ID"],"readOnly":false},"UserPointMetricDefinitionResource":{"type":"object"},"AudienceSegmentIdentifiersMetricDisplayResource":{"type":"object","properties":{"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"icon":{"type":"string","readOnly":false}},"required":["description","name"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/audience\_segment\_identifiers\_metrics

> Create an audience segment identifiers metric

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"User Defined Segment Metrics","description":"Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/audience_segment_identifiers_metrics":{"post":{"description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"requestBody":{"description":"The audience segment identifiers metric to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}}},"required":true},"tags":["User Defined Segment Metrics"],"operationId":"createAudienceSegmentIdentifiersMetric","parameters":[{"explode":false,"in":"path","style":"simple","required":true,"name":"datamart_id","schema":{"type":"string"}}],"summary":"Create an audience segment identifiers metric"}}},"components":{"schemas":{"AudienceSegmentIdentifiersMetricResource":{"type":"object","properties":{"order_index":{"type":"integer","format":"int32","default":0,"readOnly":false},"last_modified_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_by":{"type":"string","readOnly":true},"last_modified_by":{"type":"string","readOnly":true},"metric_definition":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDefinitionResource"},"archived":{"type":"boolean","default":false,"readOnly":false},"status":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricStatus"},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":true},"display":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDisplayResource"}},"required":["archived","created_by","created_ts","datamart_id","display","id","metric_definition","order_index","status"]},"AudienceSegmentIdentifiersMetricDefinitionResource":{"discriminator":{"propertyName":"type","mapping":{"USER_ACCOUNT":"#/components/schemas/UserAccountMetricDefinitionResource","QUERY":"#/components/schemas/QueryMetricDefinitionResource","USER_POINT":"#/components/schemas/UserPointMetricDefinitionResource","USER_DEVICE_POINT":"#/components/schemas/UserDevicePointMetricDefinitionResource","USER_PROFILE":"#/components/schemas/UserProfileMetricDefinitionResource","USER_DEVICE_TECHNICAL_ID":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource","USER_EMAIL":"#/components/schemas/UserEmailMetricDefinitionResource"}},"oneOf":[{"$ref":"#/components/schemas/UserDevicePointMetricDefinitionResource"},{"$ref":"#/components/schemas/QueryMetricDefinitionResource"},{"$ref":"#/components/schemas/UserEmailMetricDefinitionResource"},{"$ref":"#/components/schemas/UserAccountMetricDefinitionResource"},{"$ref":"#/components/schemas/UserProfileMetricDefinitionResource"},{"$ref":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource"},{"$ref":"#/components/schemas/UserPointMetricDefinitionResource"}],"properties":{"type":{"type":"string","enum":["USER_DEVICE_POINT","QUERY","USER_EMAIL","USER_ACCOUNT","USER_PROFILE","USER_DEVICE_TECHNICAL_ID","USER_POINT"]}},"required":["type"]},"UserDevicePointMetricDefinitionResource":{"type":"object"},"QueryMetricDefinitionResource":{"type":"object","properties":{"query_id":{"type":"string","readOnly":false}},"required":["query_id"]},"UserEmailMetricDefinitionResource":{"type":"object"},"UserAccountMetricDefinitionResource":{"type":"object","properties":{"compartment_type":{"$ref":"#/components/schemas/UserAccountCompartmentType"},"compartment_id":{"type":"string","readOnly":false}},"required":["compartment_type"]},"UserAccountCompartmentType":{"type":"string","enum":["CUSTOM_COMPARTMENT_ID","NETWORK_USER_ID"],"readOnly":false},"UserProfileMetricDefinitionResource":{"type":"object","properties":{"compartment_id":{"type":"string","readOnly":false}}},"UserDeviceTechnicalIdMetricDefinitionResource":{"type":"object","properties":{"registry_type":{"$ref":"#/components/schemas/DeviceIdRegistryType"},"registry_id":{"type":"string","readOnly":false}},"required":["registry_type"]},"DeviceIdRegistryType":{"type":"string","enum":["INSTALLATION_ID","MUM_ID","NETWORK_DEVICE_ID","CUSTOM_DEVICE_ID","MOBILE_ADVERTISING_ID","MOBILE_VENDOR_ID","TV_ADVERTISING_ID","IP_V4_ADDRESS_ID","IP_V6_ADDRESS_ID"],"readOnly":false},"UserPointMetricDefinitionResource":{"type":"object"},"AudienceSegmentIdentifiersMetricStatus":{"type":"string","enum":["INACTIVE","ACTIVE"],"readOnly":false},"AudienceSegmentIdentifiersMetricDisplayResource":{"type":"object","properties":{"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"icon":{"type":"string","readOnly":false}},"required":["description","name"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/audience\_segment\_identifiers\_metrics\_order

> Update the order of audience segment identifiers metrics by datamart

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"User Defined Segment Metrics","description":"Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/audience_segment_identifiers_metrics_order":{"put":{"parameters":[{"schema":{"type":"string"},"explode":false,"required":true,"in":"path","style":"simple","name":"datamart_id"}],"operationId":"orderAudienceSegmentIdentifiersMetrics","summary":"Update the order of audience segment identifiers metrics by datamart","requestBody":{"description":"An ordered list of the ids of the first N metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricsOrderResource"}}},"required":true},"tags":["User Defined Segment Metrics"],"description":"","responses":{"200":{"$ref":"#/components/responses/simple"},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}}}}},"components":{"schemas":{"AudienceSegmentIdentifiersMetricsOrderResource":{"type":"object","properties":{"metrics_ids":{"type":"array","items":{"type":"string","readOnly":false},"readOnly":false}},"required":["metrics_ids"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"simple":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}},"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## POST /datamarts/{datamart\_id}/audience\_segment\_identifiers\_metrics/{id}/action

> Run action on an audience segment identifiers metric

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"User Defined Segment Metrics","description":"Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/audience_segment_identifiers_metrics/{id}/action":{"post":{"summary":"Run action on an audience segment identifiers metric","description":"","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"operationId":"runAudienceSegmentIdentifiersMetricAction","requestBody":{"description":"The action to run","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricActionResource"}}},"required":true},"parameters":[{"explode":false,"schema":{"type":"string"},"in":"path","style":"simple","required":true,"name":"datamart_id"},{"name":"id","required":true,"style":"simple","explode":false,"in":"path","schema":{"type":"string"}}],"tags":["User Defined Segment Metrics"]}}},"components":{"schemas":{"AudienceSegmentIdentifiersMetricResource":{"type":"object","properties":{"order_index":{"type":"integer","format":"int32","default":0,"readOnly":false},"last_modified_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_by":{"type":"string","readOnly":true},"last_modified_by":{"type":"string","readOnly":true},"metric_definition":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDefinitionResource"},"archived":{"type":"boolean","default":false,"readOnly":false},"status":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricStatus"},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":true},"display":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDisplayResource"}},"required":["archived","created_by","created_ts","datamart_id","display","id","metric_definition","order_index","status"]},"AudienceSegmentIdentifiersMetricDefinitionResource":{"discriminator":{"propertyName":"type","mapping":{"USER_ACCOUNT":"#/components/schemas/UserAccountMetricDefinitionResource","QUERY":"#/components/schemas/QueryMetricDefinitionResource","USER_POINT":"#/components/schemas/UserPointMetricDefinitionResource","USER_DEVICE_POINT":"#/components/schemas/UserDevicePointMetricDefinitionResource","USER_PROFILE":"#/components/schemas/UserProfileMetricDefinitionResource","USER_DEVICE_TECHNICAL_ID":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource","USER_EMAIL":"#/components/schemas/UserEmailMetricDefinitionResource"}},"oneOf":[{"$ref":"#/components/schemas/UserDevicePointMetricDefinitionResource"},{"$ref":"#/components/schemas/QueryMetricDefinitionResource"},{"$ref":"#/components/schemas/UserEmailMetricDefinitionResource"},{"$ref":"#/components/schemas/UserAccountMetricDefinitionResource"},{"$ref":"#/components/schemas/UserProfileMetricDefinitionResource"},{"$ref":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource"},{"$ref":"#/components/schemas/UserPointMetricDefinitionResource"}],"properties":{"type":{"type":"string","enum":["USER_DEVICE_POINT","QUERY","USER_EMAIL","USER_ACCOUNT","USER_PROFILE","USER_DEVICE_TECHNICAL_ID","USER_POINT"]}},"required":["type"]},"UserDevicePointMetricDefinitionResource":{"type":"object"},"QueryMetricDefinitionResource":{"type":"object","properties":{"query_id":{"type":"string","readOnly":false}},"required":["query_id"]},"UserEmailMetricDefinitionResource":{"type":"object"},"UserAccountMetricDefinitionResource":{"type":"object","properties":{"compartment_type":{"$ref":"#/components/schemas/UserAccountCompartmentType"},"compartment_id":{"type":"string","readOnly":false}},"required":["compartment_type"]},"UserAccountCompartmentType":{"type":"string","enum":["CUSTOM_COMPARTMENT_ID","NETWORK_USER_ID"],"readOnly":false},"UserProfileMetricDefinitionResource":{"type":"object","properties":{"compartment_id":{"type":"string","readOnly":false}}},"UserDeviceTechnicalIdMetricDefinitionResource":{"type":"object","properties":{"registry_type":{"$ref":"#/components/schemas/DeviceIdRegistryType"},"registry_id":{"type":"string","readOnly":false}},"required":["registry_type"]},"DeviceIdRegistryType":{"type":"string","enum":["INSTALLATION_ID","MUM_ID","NETWORK_DEVICE_ID","CUSTOM_DEVICE_ID","MOBILE_ADVERTISING_ID","MOBILE_VENDOR_ID","TV_ADVERTISING_ID","IP_V4_ADDRESS_ID","IP_V6_ADDRESS_ID"],"readOnly":false},"UserPointMetricDefinitionResource":{"type":"object"},"AudienceSegmentIdentifiersMetricStatus":{"type":"string","enum":["INACTIVE","ACTIVE"],"readOnly":false},"AudienceSegmentIdentifiersMetricDisplayResource":{"type":"object","properties":{"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"icon":{"type":"string","readOnly":false}},"required":["description","name"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]},"AudienceSegmentIdentifiersMetricActionResource":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricAction"}},"required":["action"]},"AudienceSegmentIdentifiersMetricAction":{"type":"string","enum":["ACTIVATE","DEACTIVATE"],"readOnly":false}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## GET /datamarts/{datamart\_id}/audience\_segment\_identifiers\_metrics/{id}

> Get an audience segment identifiers metric by id

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"User Defined Segment Metrics","description":"Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/audience_segment_identifiers_metrics/{id}":{"get":{"operationId":"getAudienceSegmentIdentifiersMetric","summary":"Get an audience segment identifiers metric by id","responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"parameters":[{"in":"path","required":true,"explode":false,"schema":{"type":"string"},"style":"simple","name":"datamart_id"},{"schema":{"type":"string"},"name":"id","required":true,"explode":false,"style":"simple","in":"path"}],"tags":["User Defined Segment Metrics"],"description":""}}},"components":{"schemas":{"AudienceSegmentIdentifiersMetricResource":{"type":"object","properties":{"order_index":{"type":"integer","format":"int32","default":0,"readOnly":false},"last_modified_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_by":{"type":"string","readOnly":true},"last_modified_by":{"type":"string","readOnly":true},"metric_definition":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDefinitionResource"},"archived":{"type":"boolean","default":false,"readOnly":false},"status":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricStatus"},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":true},"display":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDisplayResource"}},"required":["archived","created_by","created_ts","datamart_id","display","id","metric_definition","order_index","status"]},"AudienceSegmentIdentifiersMetricDefinitionResource":{"discriminator":{"propertyName":"type","mapping":{"USER_ACCOUNT":"#/components/schemas/UserAccountMetricDefinitionResource","QUERY":"#/components/schemas/QueryMetricDefinitionResource","USER_POINT":"#/components/schemas/UserPointMetricDefinitionResource","USER_DEVICE_POINT":"#/components/schemas/UserDevicePointMetricDefinitionResource","USER_PROFILE":"#/components/schemas/UserProfileMetricDefinitionResource","USER_DEVICE_TECHNICAL_ID":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource","USER_EMAIL":"#/components/schemas/UserEmailMetricDefinitionResource"}},"oneOf":[{"$ref":"#/components/schemas/UserDevicePointMetricDefinitionResource"},{"$ref":"#/components/schemas/QueryMetricDefinitionResource"},{"$ref":"#/components/schemas/UserEmailMetricDefinitionResource"},{"$ref":"#/components/schemas/UserAccountMetricDefinitionResource"},{"$ref":"#/components/schemas/UserProfileMetricDefinitionResource"},{"$ref":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource"},{"$ref":"#/components/schemas/UserPointMetricDefinitionResource"}],"properties":{"type":{"type":"string","enum":["USER_DEVICE_POINT","QUERY","USER_EMAIL","USER_ACCOUNT","USER_PROFILE","USER_DEVICE_TECHNICAL_ID","USER_POINT"]}},"required":["type"]},"UserDevicePointMetricDefinitionResource":{"type":"object"},"QueryMetricDefinitionResource":{"type":"object","properties":{"query_id":{"type":"string","readOnly":false}},"required":["query_id"]},"UserEmailMetricDefinitionResource":{"type":"object"},"UserAccountMetricDefinitionResource":{"type":"object","properties":{"compartment_type":{"$ref":"#/components/schemas/UserAccountCompartmentType"},"compartment_id":{"type":"string","readOnly":false}},"required":["compartment_type"]},"UserAccountCompartmentType":{"type":"string","enum":["CUSTOM_COMPARTMENT_ID","NETWORK_USER_ID"],"readOnly":false},"UserProfileMetricDefinitionResource":{"type":"object","properties":{"compartment_id":{"type":"string","readOnly":false}}},"UserDeviceTechnicalIdMetricDefinitionResource":{"type":"object","properties":{"registry_type":{"$ref":"#/components/schemas/DeviceIdRegistryType"},"registry_id":{"type":"string","readOnly":false}},"required":["registry_type"]},"DeviceIdRegistryType":{"type":"string","enum":["INSTALLATION_ID","MUM_ID","NETWORK_DEVICE_ID","CUSTOM_DEVICE_ID","MOBILE_ADVERTISING_ID","MOBILE_VENDOR_ID","TV_ADVERTISING_ID","IP_V4_ADDRESS_ID","IP_V6_ADDRESS_ID"],"readOnly":false},"UserPointMetricDefinitionResource":{"type":"object"},"AudienceSegmentIdentifiersMetricStatus":{"type":"string","enum":["INACTIVE","ACTIVE"],"readOnly":false},"AudienceSegmentIdentifiersMetricDisplayResource":{"type":"object","properties":{"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"icon":{"type":"string","readOnly":false}},"required":["description","name"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```

## PUT /datamarts/{datamart\_id}/audience\_segment\_identifiers\_metrics/{id}

> Update an audience segment identifiers metric

```json
{"openapi":"3.1.1","info":{"title":"mediarithmics openapi API","version":"1.0.0"},"tags":[{"name":"User Defined Segment Metrics","description":"Operations related to Audience Segment Identifiers Metrics that define identifier-based measurements on each segment. Track specific identifier type distributions such as number of hashed emails, user device points, user accounts per compartment, cookies, and mobile advertising IDs, providing detailed visibility into segment addressability across different activation channels."}],"servers":[{"url":"http://api.mediarithmics.local/v1","description":"Development server"},{"url":"https://api.mediarithmics.com/v1","description":"Production server"}],"paths":{"/datamarts/{datamart_id}/audience_segment_identifiers_metrics/{id}":{"put":{"parameters":[{"in":"path","style":"simple","required":true,"name":"datamart_id","explode":false,"schema":{"type":"string"}},{"style":"simple","name":"id","in":"path","required":true,"explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success !","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"data":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}},"required":["data","status"]}}}},"400":{"$ref":"#/components/responses/error"},"401":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/error"},"500":{"$ref":"#/components/responses/error"},"503":{"$ref":"#/components/responses/error"}},"requestBody":{"description":"The audience segment identifiers metric to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricResource"}}},"required":true},"tags":["User Defined Segment Metrics"],"description":"","operationId":"updateAudienceSegmentIdentifiersMetric","summary":"Update an audience segment identifiers metric"}}},"components":{"schemas":{"AudienceSegmentIdentifiersMetricResource":{"type":"object","properties":{"order_index":{"type":"integer","format":"int32","default":0,"readOnly":false},"last_modified_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_ts":{"type":"integer","format":"int64","default":0,"readOnly":true},"created_by":{"type":"string","readOnly":true},"last_modified_by":{"type":"string","readOnly":true},"metric_definition":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDefinitionResource"},"archived":{"type":"boolean","default":false,"readOnly":false},"status":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricStatus"},"id":{"type":"string","readOnly":true},"datamart_id":{"type":"string","readOnly":true},"display":{"$ref":"#/components/schemas/AudienceSegmentIdentifiersMetricDisplayResource"}},"required":["archived","created_by","created_ts","datamart_id","display","id","metric_definition","order_index","status"]},"AudienceSegmentIdentifiersMetricDefinitionResource":{"discriminator":{"propertyName":"type","mapping":{"USER_ACCOUNT":"#/components/schemas/UserAccountMetricDefinitionResource","QUERY":"#/components/schemas/QueryMetricDefinitionResource","USER_POINT":"#/components/schemas/UserPointMetricDefinitionResource","USER_DEVICE_POINT":"#/components/schemas/UserDevicePointMetricDefinitionResource","USER_PROFILE":"#/components/schemas/UserProfileMetricDefinitionResource","USER_DEVICE_TECHNICAL_ID":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource","USER_EMAIL":"#/components/schemas/UserEmailMetricDefinitionResource"}},"oneOf":[{"$ref":"#/components/schemas/UserDevicePointMetricDefinitionResource"},{"$ref":"#/components/schemas/QueryMetricDefinitionResource"},{"$ref":"#/components/schemas/UserEmailMetricDefinitionResource"},{"$ref":"#/components/schemas/UserAccountMetricDefinitionResource"},{"$ref":"#/components/schemas/UserProfileMetricDefinitionResource"},{"$ref":"#/components/schemas/UserDeviceTechnicalIdMetricDefinitionResource"},{"$ref":"#/components/schemas/UserPointMetricDefinitionResource"}],"properties":{"type":{"type":"string","enum":["USER_DEVICE_POINT","QUERY","USER_EMAIL","USER_ACCOUNT","USER_PROFILE","USER_DEVICE_TECHNICAL_ID","USER_POINT"]}},"required":["type"]},"UserDevicePointMetricDefinitionResource":{"type":"object"},"QueryMetricDefinitionResource":{"type":"object","properties":{"query_id":{"type":"string","readOnly":false}},"required":["query_id"]},"UserEmailMetricDefinitionResource":{"type":"object"},"UserAccountMetricDefinitionResource":{"type":"object","properties":{"compartment_type":{"$ref":"#/components/schemas/UserAccountCompartmentType"},"compartment_id":{"type":"string","readOnly":false}},"required":["compartment_type"]},"UserAccountCompartmentType":{"type":"string","enum":["CUSTOM_COMPARTMENT_ID","NETWORK_USER_ID"],"readOnly":false},"UserProfileMetricDefinitionResource":{"type":"object","properties":{"compartment_id":{"type":"string","readOnly":false}}},"UserDeviceTechnicalIdMetricDefinitionResource":{"type":"object","properties":{"registry_type":{"$ref":"#/components/schemas/DeviceIdRegistryType"},"registry_id":{"type":"string","readOnly":false}},"required":["registry_type"]},"DeviceIdRegistryType":{"type":"string","enum":["INSTALLATION_ID","MUM_ID","NETWORK_DEVICE_ID","CUSTOM_DEVICE_ID","MOBILE_ADVERTISING_ID","MOBILE_VENDOR_ID","TV_ADVERTISING_ID","IP_V4_ADDRESS_ID","IP_V6_ADDRESS_ID"],"readOnly":false},"UserPointMetricDefinitionResource":{"type":"object"},"AudienceSegmentIdentifiersMetricStatus":{"type":"string","enum":["INACTIVE","ACTIVE"],"readOnly":false},"AudienceSegmentIdentifiersMetricDisplayResource":{"type":"object","properties":{"name":{"type":"string","readOnly":false},"description":{"type":"string","readOnly":false},"icon":{"type":"string","readOnly":false}},"required":["description","name"]},"errorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"error_code":{"type":"string","enum":["AUTHENTICATION_ERROR","AUTHORIZATION_ERROR","BAD_REQUEST_DATA","BAD_REQUEST_FORMAT","CONSTRAINT_VIOLATION_EXCEPTION","EMAIL_ALREADY_EXISTS","MAC_ERROR","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TOKEN_ERROR"]},"error_id":{"type":"string"},"error":{"type":"string"}},"required":["error","error_code","error_id","status"]}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mediarithmics.io/api-reference/datamart-management/user-defined-segment-metrics.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.