Execute a read-only GraphQL query

Operation

POST /graphql

Single GraphQL endpoint mirroring the core REST resources (advertisers, deals, transactions, clicks, publishers, networks, tags). Authentication and Pundit scoping match the REST API. The schema defines no mutations. List fields return `{ nodes, pageInfo }` with offset pagination; pass `includeTotal: true` only when a total count is required.

Parameters

This operation does not define any parameters.

Request Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "description": "GraphQL query document."
          },
          "variables": {
            "type": "object",
            "additionalProperties": true,
            "description": "Optional variables map."
          },
          "operationName": {
            "type": "string",
            "description": "Optional operation name when the document defines multiple operations."
          }
        },
        "required": [
          "query"
        ]
      }
    }
  }
}

Responses

{
  "description": "GraphQL execution result (data and/or errors)",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "additionalProperties": true,
            "nullable": true
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string"
                },
                "locations": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                },
                "path": {
                  "type": "array",
                  "items": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

{
  "$ref": "#/components/responses/Unauthorized"
}

API Playground

The in-page tester only supports GET. For POST, use the sample curl below or the dedicated resource docs (e.g. Contacts, Link Builder). Sign in to enable live testing with your API key.

Example request (replace YOUR_API_KEY or sign in above):

curl -X POST "https://app.hienergy.ai/api/v1/graphql" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"
  -H "Content-Type: application/json" \
  -d '{}'