> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supermetrics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get fields

> List available fixed and custom fields for a data source

## OpenAPI

````json GET /query/fields
{
  "openapi": "3.0.3",
  "info": {
    "title": "Data API Reference",
    "version": "2.0.0",
    "description": "API Documentation for the Supermetrics Data API including data source search capabilities. For more information, visit https://supermetrics.com.",
    "termsOfService": "https://supermetrics.com/terms-of-service",
    "contact": {
      "name": "Supermetrics Suppot",
      "email": "support@supermetrics.com",
      "url": "https://supermetrics.com/support"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "x-api-id": "sm-data-api",
    "x-audience": "public"
  },
  "servers": [
    {
      "url": "https://api.supermetrics.com/v2",
      "description": "Global production public Supermetrics Data API base path.",
      "x-internal": false
    },
    {
      "url": "https://api.supermetrics.com",
      "description": "Global production public Supermetrics API base path for datasource search.",
      "x-internal": false
    }
  ],
  "tags": [
    {
      "name": "Get data",
      "description": "Query data and retrieve results, fields, segments, and accounts"
    },
    {
      "name": "Data Source Search",
      "description": "Search and discover data sources with filtering capabilities"
    },
    {
      "name": "Destination Search",
      "description": "Search and discover destinations for your team"
    },
    {
      "name": "API Usage",
      "description": "Retrieve API usage rollups — timeseries, top breakdowns, errors, and summary"
    },
    {
      "name": "Raw Usage Data Export",
      "description": "Endpoints for creating and retrieving a team's raw usage reposts."
    },
    {
      "name": "Campaign Management",
      "description": "Create, update, and manage advertising campaigns, audiences, conversions, keywords, and related assets"
    }
  ],
  "externalDocs": {
    "description": "Find out more about Supermetrics Data API",
    "url": "https://docs.supermetrics.com/apidocs/data-api"
  },
  "paths": {
    "/query/fields": {
      "servers": [
        {
          "url": "https://api.supermetrics.com",
          "description": "production server",
          "x-internal": false
        }
      ],
      "get": {
        "summary": "Get fields",
        "description": "List available fixed and custom fields for a data source",
        "operationId": "getFields",
        "parameters": [
          {
            "name": "ds_id",
            "in": "query",
            "required": true,
            "description": "Data source ID",
            "schema": {
              "type": "string",
              "maxLength": 50,
              "pattern": "^[A-Za-z0-9_-]+$",
              "example": "GA"
            }
          },
          {
            "name": "ds_accounts",
            "in": "query",
            "required": false,
            "description": "Comma-separated list of account IDs to target. Required to return custom fields.",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "example": "example"
            }
          },
          {
            "name": "ds_users",
            "in": "query",
            "required": false,
            "description": "Comma-separated list of usernames. Required when ds_accounts is provided to return custom fields.",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "example": "example"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Fields retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FieldListResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/PermissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "security": [
          {
            "ApiKeyAuth": [
              "default",
              "any_api_key"
            ]
          }
        ],
        "tags": [
          "Get data"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "FieldListResponse": {
        "type": "object",
        "properties": {
          "meta": {
            "type": "object",
            "properties": {
              "request_id": {
                "type": "string",
                "maxLength": 50,
                "pattern": "^[A-Za-z0-9_-]+$",
                "description": "API request ID"
              }
            }
          },
          "data": {
            "type": "array",
            "description": "List of available fields for the data source.",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/DimensionFieldOutput"
                },
                {
                  "$ref": "#/components/schemas/MetricFieldOutput"
                }
              ]
            },
            "maxItems": 1000
          }
        }
      },
      "DimensionFieldOutput": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AbstractFieldOutput"
          },
          {
            "type": "object",
            "description": "Details of a dimension field, extending base field information.",
            "properties": {
              "entity_type": {
                "type": "string",
                "description": "Type of the entity (dimension).",
                "enum": [
                  "ds_dimension"
                ]
              }
            }
          }
        ]
      },
      "MetricFieldOutput": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AbstractFieldOutput"
          },
          {
            "type": "object",
            "description": "Details of a metric field, extending base field information.",
            "properties": {
              "entity_type": {
                "type": "string",
                "description": "Type of the entity (metric).",
                "enum": [
                  "ds_metric"
                ]
              },
              "is_non_aggregatable": {
                "type": "boolean",
                "description": "Indicates if the metric cannot be aggregated."
              }
            }
          }
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard envelope returned by all error (4xx/5xx) responses.",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/Meta"
          },
          "error": {
            "$ref": "#/components/schemas/Error"
          }
        },
        "required": [
          "meta",
          "error"
        ],
        "additionalProperties": false
      },
      "AbstractFieldOutput": {
        "type": "object",
        "description": "Base details of a data source field.",
        "properties": {
          "field_id": {
            "type": "string",
            "description": "Internal ID of the field.",
            "maxLength": 100
          },
          "field_name": {
            "type": "string",
            "description": "Display name of the field.",
            "maxLength": 255
          },
          "field_type": {
            "type": "string",
            "description": "Type of the field (e.g., dimension or metric).",
            "maxLength": 100
          },
          "data_type": {
            "type": "string",
            "nullable": true,
            "description": "Data type of the field.",
            "maxLength": 100
          },
          "description": {
            "type": "string",
            "description": "Description of the field.",
            "maxLength": 2000
          },
          "group_name": {
            "type": "string",
            "description": "Group name the field belongs to.",
            "maxLength": 255
          },
          "is_filterable": {
            "type": "boolean",
            "description": "Indicates if the field can be used for filtering."
          },
          "report_types": {
            "type": "array",
            "description": "List of report types that support this field.",
            "items": {
              "type": "string",
              "maxLength": 100
            },
            "maxItems": 1000
          }
        }
      },
      "Meta": {
        "type": "object",
        "description": "Metadata included in every API response.",
        "properties": {
          "request_id": {
            "$ref": "#/components/schemas/RequestId"
          }
        },
        "required": [
          "request_id"
        ],
        "additionalProperties": false
      },
      "Error": {
        "type": "object",
        "description": "Machine- and human-readable detail for a failed request.",
        "properties": {
          "code": {
            "type": "string",
            "pattern": "^[A-Z][A-Z0-9_]*$",
            "maxLength": 100,
            "description": "Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on `message`. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.",
            "example": "BAD_REQUEST"
          },
          "message": {
            "type": "string",
            "maxLength": 255,
            "pattern": "^.+$",
            "description": "Short, human-readable summary of the error.",
            "example": "The request was invalid."
          },
          "description": {
            "type": "string",
            "maxLength": 2048,
            "description": "Optional longer explanation specific to this occurrence.",
            "example": "The field 'display_name' must not be empty."
          }
        },
        "required": [
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "RequestId": {
        "type": "string",
        "description": "Unique identifier for the request, for tracking and debugging.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "minLength": 8,
        "maxLength": 64,
        "example": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN",
        "x-faker": {
          "random.alphaNumeric": 30
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad request - invalid parameters",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "BAD_REQUEST",
                "message": "The request was invalid."
              }
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized",
        "headers": {
          "WWW-Authenticate": {
            "$ref": "#/components/headers/WWW-Authenticate"
          },
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "UNAUTHORIZED",
                "message": "Authentication is required."
              }
            }
          }
        }
      },
      "PermissionDenied": {
        "description": "Permission denied",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "PERMISSION_ERROR",
                "message": "You do not have permission to perform this action."
              }
            }
          }
        }
      },
      "UnprocessableEntity": {
        "description": "Unprocessable Entity - validation failed for the request parameters",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "UNPROCESSABLE_ENTITY",
                "message": "Validation failed for the request parameters."
              }
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "Too Many Requests",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "TOO_MANY_REQUESTS",
                "message": "Rate limit exceeded. Retry later."
              }
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal server error",
        "headers": {
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "INTERNAL_SERVER_ERROR",
                "message": "An unexpected error occurred."
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API_KEY",
        "description": "API key authentication. Create API keys in the Supermetrics Hub and send\nthem in the Authorization header:\n`Authorization: Bearer <your-api-key>`\n"
      }
    },
    "headers": {
      "X-RateLimit-Limit": {
        "description": "Request limit per hour",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 10000,
          "example": 5000
        }
      },
      "X-RateLimit-Remaining": {
        "description": "Remaining requests in current window",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "maximum": 10000,
          "example": 4999
        }
      },
      "Access-Control-Allow-Origin": {
        "description": "CORS header",
        "schema": {
          "type": "string",
          "maxLength": 255,
          "enum": [
            "*"
          ],
          "example": "*"
        }
      },
      "WWW-Authenticate": {
        "description": "Bearer token required",
        "schema": {
          "type": "string",
          "maxLength": 255,
          "pattern": "^Bearer.*"
        }
      },
      "Retry-After": {
        "description": "Seconds until rate limit resets",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 86400,
          "example": 3600
        }
      }
    }
  }
}
````