--- title: "POST /userprofiles/{profileId}/reports/compatiblefields/query" method: POST path: "/userprofiles/{profileId}/reports/compatiblefields/query" tags: ["reports"] --- # POST /userprofiles/{profileId}/reports/compatiblefields/query `POST /userprofiles/{profileId}/reports/compatiblefields/query` Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. ## Path parameters - `profileId` string, required ## Request body - Report — Represents a Report resource. - `criteria` object — The report criteria for a report of type "STANDARD". - `customRichMediaEvents` CustomRichMediaEvents — Represents a Custom Rich Media Events group. - `filteredEventIds` DimensionValue[] — List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `kind` string — The kind of resource this is, in this case dfareporting#customRichMediaEvents. - `dateRange` DateRange — Represents a date range. - `startDate` string, date - `endDate` string, date - `relativeDateRange` 'TODAY' | 'YESTERDAY' | 'WEEK_TO_DATE' | 'MONTH_TO_DATE' | 'QUARTER_TO_DATE' | 'YEAR_TO_DATE' | 'PREVIOUS_WEEK' | 'PREVIOUS_MONTH' | 'PREVIOUS_QUARTER' | 'PREVIOUS_YEAR' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_365_DAYS' | 'LAST_24_MONTHS' | 'LAST_14_DAYS' | 'LAST_60_DAYS' — The date range relative to the date of when the report is run. - `kind` string — The kind of resource this is, in this case dfareporting#dateRange. - `metricNames` string[] — The list of names of metrics the report should include. - `dimensions` SortedDimension[] — The list of standard dimensions the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. - `dimensionFilters` DimensionValue[] — The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `activities` Activities — Represents an activity group. - `filters` DimensionValue[] — List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `kind` string — The kind of resource this is, in this case dfareporting#activities. - `metricNames` string[] — List of names of floodlight activity metrics. - `reachCriteria` object — The report criteria for a report of type "REACH". - `activities` Activities — Represents an activity group. - `filters` DimensionValue[] — List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `kind` string — The kind of resource this is, in this case dfareporting#activities. - `metricNames` string[] — List of names of floodlight activity metrics. - `dimensionFilters` DimensionValue[] — The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `dimensions` SortedDimension[] — The list of dimensions the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. - `metricNames` string[] — The list of names of metrics the report should include. - `dateRange` DateRange — Represents a date range. - `startDate` string, date - `endDate` string, date - `relativeDateRange` 'TODAY' | 'YESTERDAY' | 'WEEK_TO_DATE' | 'MONTH_TO_DATE' | 'QUARTER_TO_DATE' | 'YEAR_TO_DATE' | 'PREVIOUS_WEEK' | 'PREVIOUS_MONTH' | 'PREVIOUS_QUARTER' | 'PREVIOUS_YEAR' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_365_DAYS' | 'LAST_24_MONTHS' | 'LAST_14_DAYS' | 'LAST_60_DAYS' — The date range relative to the date of when the report is run. - `kind` string — The kind of resource this is, in this case dfareporting#dateRange. - `reachByFrequencyMetricNames` string[] — The list of names of Reach By Frequency metrics the report should include. - `customRichMediaEvents` CustomRichMediaEvents — Represents a Custom Rich Media Events group. - `filteredEventIds` DimensionValue[] — List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `kind` string — The kind of resource this is, in this case dfareporting#customRichMediaEvents. - `fileName` string — The filename used when generating report files for this report. - `ownerProfileId` string, int64 — The user profile id of the owner of this report. - `accountId` string, int64 — The account ID to which this report belongs. - `name` string — The name of the report. - `crossMediaReachCriteria` object — Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". - `metricNames` string[] — Required. The list of names of metrics the report should include. - `dateRange` DateRange — Represents a date range. - `startDate` string, date - `endDate` string, date - `relativeDateRange` 'TODAY' | 'YESTERDAY' | 'WEEK_TO_DATE' | 'MONTH_TO_DATE' | 'QUARTER_TO_DATE' | 'YEAR_TO_DATE' | 'PREVIOUS_WEEK' | 'PREVIOUS_MONTH' | 'PREVIOUS_QUARTER' | 'PREVIOUS_YEAR' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_365_DAYS' | 'LAST_24_MONTHS' | 'LAST_14_DAYS' | 'LAST_60_DAYS' — The date range relative to the date of when the report is run. - `kind` string — The kind of resource this is, in this case dfareporting#dateRange. - `dimensionFilters` DimensionValue[] — Required. The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `dimensions` SortedDimension[] — Required. The list of dimensions the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. - `etag` string — The eTag of this response for caching purposes. - `delivery` object — The report's email delivery settings. - `emailOwnerDeliveryType` 'LINK' | 'ATTACHMENT' — The type of delivery for the owner to receive, if enabled. - `message` string — The message to be sent with each email. - `recipients` Recipient[] — The list of recipients to which to email the report. - `kind` string — The kind of resource this is, in this case dfareporting#recipient. - `deliveryType` 'LINK' | 'ATTACHMENT' — The delivery type for the recipient. - `email` string — The email address of the recipient. - `emailOwner` boolean — Whether the report should be emailed to the report owner. - `format` 'CSV' | 'EXCEL' — The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. - `floodlightCriteria` object — The report criteria for a report of type "FLOODLIGHT". - `metricNames` string[] — The list of names of metrics the report should include. - `dateRange` DateRange — Represents a date range. - `startDate` string, date - `endDate` string, date - `relativeDateRange` 'TODAY' | 'YESTERDAY' | 'WEEK_TO_DATE' | 'MONTH_TO_DATE' | 'QUARTER_TO_DATE' | 'YEAR_TO_DATE' | 'PREVIOUS_WEEK' | 'PREVIOUS_MONTH' | 'PREVIOUS_QUARTER' | 'PREVIOUS_YEAR' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_365_DAYS' | 'LAST_24_MONTHS' | 'LAST_14_DAYS' | 'LAST_60_DAYS' — The date range relative to the date of when the report is run. - `kind` string — The kind of resource this is, in this case dfareporting#dateRange. - `customRichMediaEvents` DimensionValue[] — The list of custom rich media events to include. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `reportProperties` object — The properties of the report. - `includeAttributedIPConversions` boolean — Include conversions that have no cookie, but do have an exposure path. - `includeUnattributedCookieConversions` boolean — Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window. - `includeUnattributedIPConversions` boolean — Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion. - `dimensionFilters` DimensionValue[] — The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `floodlightConfigId` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `dimensions` SortedDimension[] — The list of dimensions the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. - `lastModifiedTime` string, uint64 — The timestamp (in milliseconds since epoch) of when this report was last modified. - `kind` string — The kind of resource this is, in this case dfareporting#report. - `type` 'STANDARD' | 'REACH' | 'PATH_TO_CONVERSION' | 'FLOODLIGHT' | 'CROSS_MEDIA_REACH' — The type of the report. - `subAccountId` string, int64 — The subaccount ID to which this report belongs if applicable. - `schedule` object — The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". - `repeats` string — The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set. - `runsOnDayOfMonth` 'DAY_OF_MONTH' | 'WEEK_OF_MONTH' — Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month. - `repeatsOnWeekDays` string[] — List of week days "WEEKLY" on which scheduled reports should run. - `startDate` string, date - `expirationDate` string, date - `every` integer — Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY". - `active` boolean — Whether the schedule is active or not. Must be set to either true or false. - `timezone` string — The timezone when the report will run. - `id` string, int64 — The unique ID identifying this report resource. - `pathToConversionCriteria` object — The report criteria for a report of type "PATH_TO_CONVERSION". - `floodlightConfigId` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `activityFilters` DimensionValue[] — The list of 'dfa:activity' values to filter on. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `metricNames` string[] — The list of names of metrics the report should include. - `dateRange` DateRange — Represents a date range. - `startDate` string, date - `endDate` string, date - `relativeDateRange` 'TODAY' | 'YESTERDAY' | 'WEEK_TO_DATE' | 'MONTH_TO_DATE' | 'QUARTER_TO_DATE' | 'YEAR_TO_DATE' | 'PREVIOUS_WEEK' | 'PREVIOUS_MONTH' | 'PREVIOUS_QUARTER' | 'PREVIOUS_YEAR' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_365_DAYS' | 'LAST_24_MONTHS' | 'LAST_14_DAYS' | 'LAST_60_DAYS' — The date range relative to the date of when the report is run. - `kind` string — The kind of resource this is, in this case dfareporting#dateRange. - `customRichMediaEvents` DimensionValue[] — The list of custom rich media events to include. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `reportProperties` object — The properties of the report. - `clicksLookbackWindow` integer — CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90. - `maximumClickInteractions` integer — The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report. - `maximumImpressionInteractions` integer — The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report. - `impressionsLookbackWindow` integer — CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90. - `pivotOnInteractionPath` boolean — Enable pivoting on interaction path. - `includeAttributedIPConversions` boolean — Deprecated: has no effect. - `includeUnattributedCookieConversions` boolean — Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window. - `maximumInteractionGap` integer — The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90. - `includeUnattributedIPConversions` boolean — Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion. - `customFloodlightVariables` SortedDimension[] — The list of custom floodlight variables the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. - `perInteractionDimensions` SortedDimension[] — The list of per interaction dimensions the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. - `conversionDimensions` SortedDimension[] — The list of conversion dimensions the report should include. - `sortOrder` 'ASCENDING' | 'DESCENDING' — An optional sort order for the dimension column. - `kind` string — The kind of resource this is, in this case dfareporting#sortedDimension. - `name` string — The name of the dimension. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dfareporting.md) · [All operations](https://skmtc.net/google/apis/dfareporting/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dfareporting/revisions/8163d57aeb31/schema)