Data APIs tab

Use the Data APIs tab to explore GraphQL Data API metadata for a selected subject area. The tab presents read-only mappings and request details; it does not build, execute, or validate GraphQL requests.

• Open the Data APIs tab - Select Data APIs from the Data Studio tab bar.

• Select a subject area - Choose the subject area that contains the API metadata you want to review. The page displays its description and the number of metadata records available.

• Browse mappings - Expand the folder rows to browse Data API metadata. Depending on the selected item, Data Studio can show Attribute Name, Type, PII, Table Column, API Name, API Input Argument Name, API Input Argument Group, Filter, and Description.

• Search - Enter all or part of an attribute name to narrow the attributes shown within the selected subject area. Clear Search to return to the full selected subject area.

• Review the legend - Select Legend to interpret filter requirements and calculated fields. An asterisk (*) marks an attribute that must be selected as a filter. Two asterisks (**) mean that one or more similarly marked attributes must be selected as filters. Calculated field means that the value is derived from an expression that may reference multiple tables or columns.

• Download - Select Download and choose HTML, PDF, or Excel. Before downloading, confirm that the intended subject area is selected.

Understanding API mappings and input parameters

Use API mapping details as reference when evaluating candidate fields and request requirements.

• Table Column shows the source mapping associated with an API field. Do not infer a supported database join or complete lineage from the mapping alone.

• API Name identifies the GraphQL API associated with the selected metadata item.

• Description explains the purpose of the field. Use it to assess whether the field may have the business meaning required by the integration.

• API Input Argument Name and API Input Argument Group identify values supplied with an API request. Review them with the Filter column before building the request.

• Before implementation, confirm the mapping against the supported GraphQL documentation and schema for the target R&A release and your environment's access. Validate field meaning, record grain, cardinality, required filters, and response behavior with representative data.