List Operations

listRuns

Returns a paginated list of execution runs.

query ListRuns($limit: Int = 10, $offset: Int = 0) {
  listRuns(limit: $limit, offset: $offset) {
    items {
      id
      success
      error
      startedAt
      completedAt
      data
      config {
        ... on ApiConfig {
          id
          urlHost
          method
        }
        ... on ExtractConfig {
          id
          fileType
        }
        ... on TransformConfig {
          id
          responseSchema
        }
      }
    }
    total
  }
}

listApis

Returns a paginated list of API configurations.

query ListApis($limit: Int = 10, $offset: Int = 0) {
  listApis(limit: $limit, offset: $offset) {
    items {
      id
      urlHost
      urlPath
      method
      authentication
      createdAt
      updatedAt
    }
    total
  }
}

listTransforms

Returns a paginated list of transform configurations.

query ListTransforms($limit: Int = 10, $offset: Int = 0) {
  listTransforms(limit: $limit, offset: $offset) {
    items {
      id
      responseSchema
      responseMapping
      createdAt
      updatedAt
    }
    total
  }
}

listExtracts

Returns a paginated list of extract configurations.

query ListExtracts($limit: Int = 10, $offset: Int = 0) {
  listExtracts(limit: $limit, offset: $offset) {
    items {
      id
      urlHost
      fileType
      decompressionMethod
      createdAt
      updatedAt
    }
    total
  }
}

Get Operations

getRun

Retrieves a specific execution run by ID.

query GetRun($id: ID!) {
  getRun(id: $id) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      id
      # Config fields vary by type
    }
  }
}

getApi

Retrieves a specific API configuration by ID. Returns ApiConfig.

query GetApi($id: ID!) {
  getApi(id: $id) {
    id
    urlHost
    urlPath
    method
    headers
    queryParams
    authentication
    createdAt
    updatedAt
  }
}

getTransform

Retrieves a specific transform configuration by ID. Returns TransformConfig.

query GetTransform($id: ID!) {
  getTransform(id: $id) {
    id
    responseSchema
    responseMapping
    createdAt
    updatedAt
  }
}

getExtract

Retrieves a specific extract configuration by ID. Returns ExtractConfig.

query GetExtract($id: ID!) {
  getExtract(id: $id) {
    id
    urlHost
    fileType
    decompressionMethod
    createdAt
    updatedAt
  }
}

generateSchema

Generates a JSON schema based on instructions and optional response data. Used to automatically create sensible response JSON schemas to return API data in.

query GenerateSchema($instruction: String!, $responseData: String) {
  generateSchema(instruction: $instruction, responseData: $responseData)
}

See also: