Search and browse available Pinterest Ads reporting metrics and dimensions before running reports
Search and browse available Pinterest Ads reporting metrics and dimensions before running reports. Use filters to search fields by name or ID e.g [{‘field’:‘id’,‘operator’:‘REGEXP_MATCH’,‘value’:’.(spend|clicks).’}].
Filter by field type: ‘all’, ‘dimension’, or ‘metric’. Default is ‘all’.
filters
array of FilterItem
No
-
Use this to search fields by name or ID. Each filter must have a field, operator, and value. Available fields to filter by are: - ‘id’: The field ID [{“field”:“id”,“operator”:“REGEXP_MATCH”,“value”:”.(session|user).”}] - ‘name’: The field name [{“field”:“name”,“operator”:“CONTAINS”,“value”:“session”}] Filters are combined using AND logic. If you want to use OR logic, use relevant operators like REGEXP_MATCH or IN_LIST.
limit
integer
No
-
The maximum number of fields to return. Set it to avoid too many results.
The field to filter on, must be one of the current selected metrics or dimensions.
operator
string
Yes
-
The operator to use for filtering. Must be one of the supported values. Use REGEXP_MATCH to search/filter by multiple OR values like ’.(summer|holiday).’
value
string
Yes
-
The value to filter by, always as a string: text, a number, or a regex. For IN_LIST and NOT_IN_LIST, pass the values as one comma-separated string such as ‘a,b,c’, not as an array. For regex values, escape backslashes once in the JSON string: write \b for a word boundary, not \b.