Example

Query

query analysisQuery($accountId: String!, $pipelineId: [String!], $query: AWSJSON!) {
  analysisQuery(accountId: $accountId, pipelineId: $pipelineId, query: $query) {
    queryResult
  }
}

Variables

{
  "accountId": "abc123",
  "pipelineId": ["xyz789"],
  "query": AWSJSON
}

Response

{"data": {"analysisQuery": {"queryResult": AWSJSON}}}

Example

Query

query countInsights($accountId: String!, $clientId: String, $isResolved: Boolean, $nextToken: String, $type: String) {
  countInsights(accountId: $accountId, clientId: $clientId, isResolved: $isResolved, nextToken: $nextToken, type: $type) {
    count
    text
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "isResolved": true,
  "nextToken": "abc123",
  "type": "xyz789"
}

Response

{"data": {"countInsights": {"count": 123, "text": "abc123"}}}

Example

Query

query dropDownClients($accountId: ID!, $count: Int, $isArchived: Boolean, $nextToken: String) {
  dropDownClients(accountId: $accountId, count: $count, isArchived: $isArchived, nextToken: $nextToken) {
    items {
      ...ClientFragment
    }
    nextToken
  }
}

Variables

{
  "accountId": ID,
  "count": 123,
  "isArchived": true,
  "nextToken": "abc123"
}

Response

{
  "data": {
    "dropDownClients": {
      "items": [Client],
      "nextToken": "xyz789"
    }
  }
}

Example

Query

query dsGetBudgetDetails($accountId: String!, $budgetId: String!, $clientIds: [String]!, $endDate: String, $getHistorical: Boolean, $lastEvaluatedKey: String, $startDate: String) {
  dsGetBudgetDetails(accountId: $accountId, budgetId: $budgetId, clientIds: $clientIds, endDate: $endDate, getHistorical: $getHistorical, lastEvaluatedKey: $lastEvaluatedKey, startDate: $startDate) {
    accountId
    authEmail
    changeHistory
    client {
      ...ClientFragment
    }
    clientId
    clientName
    commentCount
    comments(lastCommentTimestamp: $lastCommentTimestamp, limit: $limit) {
      ...CommentFragment
    }
    configuration {
      ...BudgetConfigurationFragment
    }
    connectionStatus
    dateCreated
    dateUpdated
    history
    isArchived
    isDeleted
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifySchedEmail
    notifySchedSlack
    notifySchedWebhook
    plannerData {
      ...plannerMapDetailsFragment
    }
    report {
      ...BudgetReportFragment
    }
    revisions
    schedEmail
    schedSlack
    schedWebhook
    service
    sortKey
    title
    user {
      ...UserFragment
    }
    userId
    watchList
    webhookEvents
    webhookURL
  }
}

Variables

{
  "accountId": "abc123",
  "budgetId": "xyz789",
  "clientIds": ["xyz789"],
  "endDate": "xyz789",
  "getHistorical": false,
  "lastEvaluatedKey": "xyz789",
  "startDate": "xyz789"
}

Response

{
  "data": {
    "dsGetBudgetDetails": [
      {
        "accountId": "xyz789",
        "authEmail": "xyz789",
        "changeHistory": "xyz789",
        "client": Client,
        "clientId": "xyz789",
        "clientName": "abc123",
        "commentCount": 123,
        "comments": [Comment],
        "configuration": BudgetConfiguration,
        "connectionStatus": "abc123",
        "dateCreated": "abc123",
        "dateUpdated": "abc123",
        "history": AWSJSON,
        "isArchived": true,
        "isDeleted": false,
        "jobStatus": REPORT_STATUS,
        "jobType": "xyz789",
        "notifyConfig": NotifyConfig,
        "notifySchedEmail": "abc123",
        "notifySchedSlack": "abc123",
        "notifySchedWebhook": "xyz789",
        "plannerData": [plannerMapDetails],
        "report": BudgetReport,
        "revisions": 987,
        "schedEmail": "xyz789",
        "schedSlack": "abc123",
        "schedWebhook": "xyz789",
        "service": SERVICE,
        "sortKey": "xyz789",
        "title": "abc123",
        "user": User,
        "userId": "abc123",
        "watchList": ["abc123"],
        "webhookEvents": [WEBHOOK_ENUM],
        "webhookURL": "abc123"
      }
    ]
  }
}

Example

Query

query dsGetKPIDetails($accountId: String!, $clientIds: [String]!, $endDate: String, $getHistorical: Boolean, $kpiId: String!, $lastEvaluatedKey: String, $startDate: String) {
  dsGetKPIDetails(accountId: $accountId, clientIds: $clientIds, endDate: $endDate, getHistorical: $getHistorical, kpiId: $kpiId, lastEvaluatedKey: $lastEvaluatedKey, startDate: $startDate) {
    accountId
    advancedSettings
    changeHistory
    client {
      ...ClientFragment
    }
    clientId
    clientName
    commentCount
    comments(lastCommentTimestamp: $lastCommentTimestamp, limit: $limit) {
      ...CommentFragment
    }
    configuration {
      ...KPIConfigurationFragment
    }
    connectionStatus
    dateCreated
    dateUpdated
    history
    id
    isArchived
    isDeleted
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifySchedEmail
    notifySchedSlack
    notifySchedWebhook
    report {
      ...KPIReportFragment
    }
    revisions
    schedEmail
    schedSlack
    schedWebhook
    service
    sortKey
    title
    user {
      ...UserFragment
    }
    userId
    watchList
    webhookEvents
    webhookURL
  }
}

Variables

{
  "accountId": "xyz789",
  "clientIds": ["abc123"],
  "endDate": "xyz789",
  "getHistorical": false,
  "kpiId": "abc123",
  "lastEvaluatedKey": "abc123",
  "startDate": "abc123"
}

Response

{
  "data": {
    "dsGetKPIDetails": [
      {
        "accountId": "abc123",
        "advancedSettings": AWSJSON,
        "changeHistory": "xyz789",
        "client": Client,
        "clientId": "xyz789",
        "clientName": "abc123",
        "commentCount": 987,
        "comments": [Comment],
        "configuration": KPIConfiguration,
        "connectionStatus": "xyz789",
        "dateCreated": "xyz789",
        "dateUpdated": "abc123",
        "history": AWSJSON,
        "id": "abc123",
        "isArchived": true,
        "isDeleted": true,
        "jobStatus": REPORT_STATUS,
        "jobType": "xyz789",
        "notifyConfig": NotifyConfig,
        "notifySchedEmail": "abc123",
        "notifySchedSlack": "abc123",
        "notifySchedWebhook": "xyz789",
        "report": KPIReport,
        "revisions": 123,
        "schedEmail": "xyz789",
        "schedSlack": "abc123",
        "schedWebhook": "abc123",
        "service": SERVICE,
        "sortKey": "abc123",
        "title": "xyz789",
        "user": User,
        "userId": "abc123",
        "watchList": ["xyz789"],
        "webhookEvents": [WEBHOOK_ENUM],
        "webhookURL": "abc123"
      }
    ]
  }
}

Example

Query

query dsListCommentsUnderItem($accountId: String!, $clientIds: [String], $endDate: String, $itemKeys: [String], $startDate: String) {
  dsListCommentsUnderItem(accountId: $accountId, clientIds: $clientIds, endDate: $endDate, itemKeys: $itemKeys, startDate: $startDate) {
    accountId
    commentMethod
    commentTimestamp
    commentTo
    dateCreated
    dateUpdated
    deletedBy
    isDeleted
    mentionedUsers
    message
    revisions
    sortKey
    type
    updatedBy
    user {
      ...UserFragment
    }
    userId
  }
}

Variables

{
  "accountId": "xyz789",
  "clientIds": ["abc123"],
  "endDate": "xyz789",
  "itemKeys": ["abc123"],
  "startDate": "abc123"
}

Response

{
  "data": {
    "dsListCommentsUnderItem": [
      {
        "accountId": "xyz789",
        "commentMethod": CommentMethod,
        "commentTimestamp": "xyz789",
        "commentTo": "abc123",
        "dateCreated": "xyz789",
        "dateUpdated": "abc123",
        "deletedBy": "abc123",
        "isDeleted": false,
        "mentionedUsers": ["abc123"],
        "message": "xyz789",
        "revisions": 123,
        "sortKey": "abc123",
        "type": CommentType,
        "updatedBy": "xyz789",
        "user": User,
        "userId": "xyz789"
      }
    ]
  }
}

Example

Query

query dsListInsightsUnderAccount($accountId: String!, $clientIds: [String], $endDate: String!, $filters: [labelInput], $startDate: String!) {
  dsListInsightsUnderAccount(accountId: $accountId, clientIds: $clientIds, endDate: $endDate, filters: $filters, startDate: $startDate) {
    count
    id
    items {
      ...InsightsFragment
    }
    nextToken
    scannedCount
  }
}

Variables

{
  "accountId": "xyz789",
  "clientIds": ["xyz789"],
  "endDate": "xyz789",
  "filters": [labelInput],
  "startDate": "xyz789"
}

Response

{
  "data": {
    "dsListInsightsUnderAccount": {
      "count": 987,
      "id": "xyz789",
      "items": [Insights],
      "nextToken": "abc123",
      "scannedCount": 123
    }
  }
}

Example

Query

query getAccount($accountId: String!, $sortKey: String!) {
  getAccount(accountId: $accountId, sortKey: $sortKey) {
    accountId
    accountType
    betaAccess
    clientId
    clientList
    cubeToken
    dateCreated
    dateUpdated
    domain
    hasCard
    inProgress
    logo
    name
    revisions
    sortKey
    status
    timezone
    totalAnomalies
    totalBudgets
    totalClients
    totalKpis
    transactionStatus
    weekStart
    zapierWebHook
  }
}

Variables

{"accountId": "abc123", "sortKey": "abc123"}

Response

{
  "data": {
    "getAccount": {
      "accountId": "abc123",
      "accountType": "abc123",
      "betaAccess": false,
      "clientId": "xyz789",
      "clientList": ["xyz789"],
      "cubeToken": "abc123",
      "dateCreated": "abc123",
      "dateUpdated": "xyz789",
      "domain": "abc123",
      "hasCard": false,
      "inProgress": false,
      "logo": "xyz789",
      "name": "xyz789",
      "revisions": 123,
      "sortKey": "xyz789",
      "status": "xyz789",
      "timezone": "xyz789",
      "totalAnomalies": 123,
      "totalBudgets": 123,
      "totalClients": 123,
      "totalKpis": 123,
      "transactionStatus": "abc123",
      "weekStart": "abc123",
      "zapierWebHook": AWSJSON
    }
  }
}

Example

Query

query getAccountAddOns($accountId: String!, $addOnId: String!) {
  getAccountAddOns(accountId: $accountId, addOnId: $addOnId) {
    accountId
    addOnId
    details {
      ...AddOnPackFragment
    }
  }
}

Variables

{"accountId": "abc123", "addOnId": "xyz789"}

Response

{
  "data": {
    "getAccountAddOns": {
      "accountId": "abc123",
      "addOnId": "abc123",
      "details": [AddOnPack]
    }
  }
}

Example

Query

query getAccountConnection($accountId: String!, $sortKey: String!) {
  getAccountConnection(accountId: $accountId, sortKey: $sortKey) {
    accountId
    authStatus
    clientList
    domain
    email
    isClientConnected
    isCompleted
    oauthType
    scopes
    sortKey
    teamId
    teamName
    url
    userId
    username
  }
}

Variables

{"accountId": "abc123", "sortKey": "abc123"}

Response

{
  "data": {
    "getAccountConnection": {
      "accountId": "xyz789",
      "authStatus": CONNECTION_STATUS,
      "clientList": ["xyz789"],
      "domain": "abc123",
      "email": "xyz789",
      "isClientConnected": true,
      "isCompleted": true,
      "oauthType": "xyz789",
      "scopes": ["abc123"],
      "sortKey": "xyz789",
      "teamId": "abc123",
      "teamName": "xyz789",
      "url": "abc123",
      "userId": "abc123",
      "username": "abc123"
    }
  }
}

Example

Query

query getAccountInvoices($accountId: String!) {
  getAccountInvoices(accountId: $accountId) {
    accountId
    invoices {
      ...AccountInvoiceFragment
    }
  }
}

Variables

{"accountId": "abc123"}

Response

{
  "data": {
    "getAccountInvoices": {
      "accountId": "xyz789",
      "invoices": [AccountInvoice]
    }
  }
}

Example

Query

query getAccountPreference($accountId: String) {
  getAccountPreference(accountId: $accountId) {
    budgets {
      ...BudgetPreferenceFragment
    }
    dataWarehouse {
      ...DataWarehouseFragment
    }
    insights {
      ...InsightPreferenceFragment
    }
    kpis {
      ...KpiPreferenceFragment
    }
    revision
  }
}

Variables

{"accountId": "abc123"}

Response

{
  "data": {
    "getAccountPreference": {
      "budgets": BudgetPreference,
      "dataWarehouse": DataWarehouse,
      "insights": InsightPreference,
      "kpis": KpiPreference,
      "revision": 987
    }
  }
}

Example

Query

query getAdsCampaignFilter($input: AdsCampaignFilterInput) {
  getAdsCampaignFilter(input: $input) {
    id
    labels
    name
  }
}

Variables

{"input": AdsCampaignFilterInput}

Response

{
  "data": {
    "getAdsCampaignFilter": [
      {"id": "xyz789", "labels": ["abc123"], "name": "abc123"}
    ]
  }
}

Example

Query

query getAdsLabelLists($accountId: String!, $clientId: String!, $refresh: Boolean!, $source: AdsCampaignSource) {
  getAdsLabelLists(accountId: $accountId, clientId: $clientId, refresh: $refresh, source: $source) {
    backgroundColor
    description
    id
    name
    resourceName
  }
}

Variables

{
  "accountId": "abc123",
  "clientId": "xyz789",
  "refresh": true,
  "source": AdsCampaignSource
}

Response

{
  "data": {
    "getAdsLabelLists": [
      {
        "backgroundColor": "xyz789",
        "description": "xyz789",
        "id": "abc123",
        "name": "xyz789",
        "resourceName": "xyz789"
      }
    ]
  }
}

Example

Query

query getAnomalyDetails($accountId: String!, $sortKey: String!) {
  getAnomalyDetails(accountId: $accountId, sortKey: $sortKey) {
    accountId
    authId
    changeHistory
    clientId
    clientName
    commentCount
    configuration {
      ...AnomalyConfigurationFragment
    }
    connectionStatus
    dateCreated
    dateLastInsightCreated
    dateLastRun
    dateUpdated
    errorDetails {
      ...PipelineErrorDetailsFragment
    }
    isArchived
    isDeleted
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifyEmail
    notifySlack
    notifyWebhook
    report {
      ...AnomalyReportFragment
    }
    revisions
    schedWebhook
    service
    sortKey
    title
    userId
    watchList
    webhookURL
  }
}

Variables

{"accountId": "xyz789", "sortKey": "abc123"}

Response

{
  "data": {
    "getAnomalyDetails": {
      "accountId": "xyz789",
      "authId": "abc123",
      "changeHistory": "abc123",
      "clientId": "abc123",
      "clientName": "abc123",
      "commentCount": 987,
      "configuration": AnomalyConfiguration,
      "connectionStatus": "xyz789",
      "dateCreated": "abc123",
      "dateLastInsightCreated": "xyz789",
      "dateLastRun": "xyz789",
      "dateUpdated": "abc123",
      "errorDetails": PipelineErrorDetails,
      "isArchived": false,
      "isDeleted": true,
      "jobStatus": ANOMALY_STATUS,
      "jobType": "abc123",
      "notifyConfig": NotifyConfig,
      "notifyEmail": false,
      "notifySlack": false,
      "notifyWebhook": true,
      "report": AnomalyReport,
      "revisions": 987,
      "schedWebhook": "abc123",
      "service": SERVICE,
      "sortKey": "abc123",
      "title": "xyz789",
      "userId": "xyz789",
      "watchList": ["abc123"],
      "webhookURL": "abc123"
    }
  }
}

Example

Query

query getAnomalyPreviewReport($input: AnomalyPreviewConfigurationInput) {
  getAnomalyPreviewReport(input: $input) {
    errorMessage
    executionArn
    id
    message
    report {
      ...AnomalyReportFragment
    }
    stage
    status
  }
}

Variables

{"input": AnomalyPreviewConfigurationInput}

Response

{
  "data": {
    "getAnomalyPreviewReport": {
      "errorMessage": AWSJSON,
      "executionArn": "xyz789",
      "id": ID,
      "message": "abc123",
      "report": AnomalyReport,
      "stage": AnomalyPreviewStage,
      "status": AnomalyPreviewStatus
    }
  }
}

Example

Query

query getAutomationDetails($accountId: String!, $clientId: String, $sortKey: String!) {
  getAutomationDetails(accountId: $accountId, clientId: $clientId, sortKey: $sortKey) {
    accountId
    clientId
    clientName
    cognitoUserId
    configuration
    connectionStatus
    dateLastInsightCreated
    dateLastRun
    executionArn
    gmbLocationId
    isArchived
    isDeleted
    jobId
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifyEmail
    notifySlack
    notifyWebhook
    revisions
    service
    sortKey
    title
    webhookURL
  }
}

Variables

{"accountId": "abc123", "clientId": "abc123", "sortKey": "abc123"}

Response

{
  "data": {
    "getAutomationDetails": {
      "accountId": "abc123",
      "clientId": "xyz789",
      "clientName": "abc123",
      "cognitoUserId": "xyz789",
      "configuration": AWSJSON,
      "connectionStatus": "abc123",
      "dateLastInsightCreated": "xyz789",
      "dateLastRun": "abc123",
      "executionArn": "xyz789",
      "gmbLocationId": "abc123",
      "isArchived": true,
      "isDeleted": true,
      "jobId": "abc123",
      "jobStatus": ANOMALY_STATUS,
      "jobType": "xyz789",
      "notifyConfig": NotifyConfig,
      "notifyEmail": true,
      "notifySlack": true,
      "notifyWebhook": false,
      "revisions": 987,
      "service": SERVICE,
      "sortKey": "abc123",
      "title": "xyz789",
      "webhookURL": "abc123"
    }
  }
}

Example

Query

query getAutomationJobs {
  getAutomationJobs {
    id
    title
  }
}

Response

{"data": {"getAutomationJobs": [{"id": "xyz789", "title": "xyz789"}]}}

Example

Query

query getBudgetDetails($accountId: String!, $sortKey: String!) {
  getBudgetDetails(accountId: $accountId, sortKey: $sortKey) {
    accountId
    authEmail
    changeHistory
    client {
      ...ClientFragment
    }
    clientId
    clientName
    commentCount
    comments(lastCommentTimestamp: $lastCommentTimestamp, limit: $limit) {
      ...CommentFragment
    }
    configuration {
      ...BudgetConfigurationFragment
    }
    connectionStatus
    dateCreated
    dateUpdated
    history
    isArchived
    isDeleted
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifySchedEmail
    notifySchedSlack
    notifySchedWebhook
    plannerData {
      ...plannerMapDetailsFragment
    }
    report {
      ...BudgetReportFragment
    }
    revisions
    schedEmail
    schedSlack
    schedWebhook
    service
    sortKey
    title
    user {
      ...UserFragment
    }
    userId
    watchList
    webhookEvents
    webhookURL
  }
}

Variables

{"accountId": "abc123", "sortKey": "abc123"}

Response

{
  "data": {
    "getBudgetDetails": {
      "accountId": "xyz789",
      "authEmail": "xyz789",
      "changeHistory": "xyz789",
      "client": Client,
      "clientId": "abc123",
      "clientName": "xyz789",
      "commentCount": 123,
      "comments": [Comment],
      "configuration": BudgetConfiguration,
      "connectionStatus": "xyz789",
      "dateCreated": "xyz789",
      "dateUpdated": "xyz789",
      "history": AWSJSON,
      "isArchived": false,
      "isDeleted": true,
      "jobStatus": REPORT_STATUS,
      "jobType": "abc123",
      "notifyConfig": NotifyConfig,
      "notifySchedEmail": "xyz789",
      "notifySchedSlack": "xyz789",
      "notifySchedWebhook": "xyz789",
      "plannerData": [plannerMapDetails],
      "report": BudgetReport,
      "revisions": 123,
      "schedEmail": "xyz789",
      "schedSlack": "abc123",
      "schedWebhook": "xyz789",
      "service": SERVICE,
      "sortKey": "abc123",
      "title": "abc123",
      "user": User,
      "userId": "xyz789",
      "watchList": ["abc123"],
      "webhookEvents": [WEBHOOK_ENUM],
      "webhookURL": "abc123"
    }
  }
}

Example

Query

query getBudgetPreview($input: BudgetPreviewInput) {
  getBudgetPreview(input: $input) {
    errorMessage
    executionArn
    id
    message
    report {
      ...BudgetReportFragment
    }
    stage
    status
  }
}

Variables

{"input": BudgetPreviewInput}

Response

{
  "data": {
    "getBudgetPreview": {
      "errorMessage": AWSJSON,
      "executionArn": "xyz789",
      "id": ID,
      "message": "xyz789",
      "report": BudgetReport,
      "stage": PREVIEW_STAGE,
      "status": BudgetPreviewStatus
    }
  }
}

Example

Query

query getBudgetPreviewReport($input: BudgetPreviewConfigurationInput) {
  getBudgetPreviewReport(input: $input) {
    errorMessage
    executionArn
    id
    message
    report {
      ...BudgetReportFragment
    }
    stage
    status
  }
}

Variables

{"input": BudgetPreviewConfigurationInput}

Response

{
  "data": {
    "getBudgetPreviewReport": {
      "errorMessage": AWSJSON,
      "executionArn": "xyz789",
      "id": ID,
      "message": "xyz789",
      "report": BudgetReport,
      "stage": PREVIEW_STAGE,
      "status": BudgetPreviewStatus
    }
  }
}

Example

Query

query getBudgetSpreadsheetPreviewReport($input: BudgetSpreadsheetPreviewConfigurationInput) {
  getBudgetSpreadsheetPreviewReport(input: $input) {
    executionArn
    id
    jobStatus
    message
    report {
      ...BudgetReportFragment
    }
    stage
    status
  }
}

Variables

{"input": BudgetSpreadsheetPreviewConfigurationInput}

Response

{
  "data": {
    "getBudgetSpreadsheetPreviewReport": {
      "executionArn": "abc123",
      "id": ID,
      "jobStatus": REPORT_STATUS,
      "message": "xyz789",
      "report": BudgetReport,
      "stage": PREVIEW_STAGE,
      "status": BUDGET_PREVIEW_STATUS
    }
  }
}

Example

Query

query getChangeHistory($accountId: String!, $sortKey: String!) {
  getChangeHistory(accountId: $accountId, sortKey: $sortKey) {
    changes
    timestamp
    userId
  }
}

Variables

{"accountId": "abc123", "sortKey": "abc123"}

Response

{
  "data": {
    "getChangeHistory": [
      {
        "changes": [AWSJSON],
        "timestamp": "xyz789",
        "userId": "abc123"
      }
    ]
  }
}

Example

Query

query getClient($accountId: String!, $clientId: String!, $excludeInsight: [String], $isArchived: Boolean) {
  getClient(accountId: $accountId, clientId: $clientId, excludeInsight: $excludeInsight, isArchived: $isArchived) {
    Anomaly(filters: $filters, isArchived: $isArchived, nextToken: $nextToken) {
      ...AnomalyConnectionFragment
    }
    Automation(filters: $filters, isArchived: $isArchived, nextToken: $nextToken) {
      ...AutomationFragment
    }
    Budget(filters: $filters, isArchived: $isArchived) {
      ...BudgetConnectionFragment
    }
    Insight(exclude: $exclude, filters: $filters, isResolved: $isResolved, nextToken: $nextToken, type: $type) {
      ...InsightsConnectionFragment
    }
    KPI(filters: $filters, isArchived: $isArchived) {
      ...KPIConnectionFragment
    }
    accountConnectionStatus(authStatus: $authStatus, oauthType: $oauthType) {
      ...AccountConnectionFragment
    }
    accountId
    anomalyTotal
    automationTotal
    budgetTotal
    budgets {
      ...TotalBudgetStatusFragment
    }
    connectionStatus {
      ...ClientConnectionServicesStatusFragment
    }
    dateCreated
    dateUpdated
    domain
    facebookAds {
      ...FacebookAdsConnectionFragment
    }
    globalConnectionStatus
    googleAds {
      ...GoogleAdsFragment
    }
    googleAnalytics {
      ...GoogleAnalyticsFragment
    }
    googleAnalytics4 {
      ...googleAnalytics4Fragment
    }
    googleMyBusiness {
      ...GoogleMyBusinessFragment
    }
    googleSearchConsole {
      ...GoogleSearchConsoleFragment
    }
    id
    insightTotal
    instagramAds {
      ...InstagramAdsFragment
    }
    isArchived
    isDeleted
    kpiTotal
    kpis {
      ...TotalKPIStatusFragment
    }
    labels {
      ...LabelFragment
    }
    linkedInAds {
      ...linkedInAdsFragment
    }
    logo
    microsoftAds {
      ...microsoftAdsFragment
    }
    name
    revisions
    sortKey
    tiktokAds {
      ...tiktokAdsFragment
    }
    twitterAds {
      ...twitterAdsFragment
    }
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "excludeInsight": ["abc123"],
  "isArchived": false
}

Response

{
  "data": {
    "getClient": {
      "Anomaly": AnomalyConnection,
      "Automation": [Automation],
      "Budget": BudgetConnection,
      "Insight": InsightsConnection,
      "KPI": KPIConnection,
      "accountConnectionStatus": [AccountConnection],
      "accountId": "abc123",
      "anomalyTotal": 987,
      "automationTotal": 123,
      "budgetTotal": 123,
      "budgets": TotalBudgetStatus,
      "connectionStatus": ClientConnectionServicesStatus,
      "dateCreated": "abc123",
      "dateUpdated": "xyz789",
      "domain": "abc123",
      "facebookAds": FacebookAdsConnection,
      "globalConnectionStatus": GlobalConnectionStatusENUM,
      "googleAds": GoogleAds,
      "googleAnalytics": GoogleAnalytics,
      "googleAnalytics4": googleAnalytics4,
      "googleMyBusiness": GoogleMyBusiness,
      "googleSearchConsole": GoogleSearchConsole,
      "id": ID,
      "insightTotal": 987,
      "instagramAds": InstagramAds,
      "isArchived": true,
      "isDeleted": false,
      "kpiTotal": 123,
      "kpis": TotalKPIStatus,
      "labels": [Label],
      "linkedInAds": linkedInAds,
      "logo": "abc123",
      "microsoftAds": microsoftAds,
      "name": "abc123",
      "revisions": 987,
      "sortKey": "abc123",
      "tiktokAds": tiktokAds,
      "twitterAds": twitterAds
    }
  }
}

Example

Query

query getClientConnection($accountId: String!, $clientId: String!) {
  getClientConnection(accountId: $accountId, clientId: $clientId) {
    accountId
    connectionStatus {
      ...ClientConnectionServicesStatusFragment
    }
    facebookAds {
      ...FacebookAdsConnectionFragment
    }
    googleAds {
      ...GoogleAdsFragment
    }
    googleAnalytics {
      ...GoogleAnalyticsFragment
    }
    googleAnalytics4 {
      ...googleAnalytics4Fragment
    }
    googleMyBusiness {
      ...GoogleMyBusinessFragment
    }
    googleSearchConsole {
      ...GoogleSearchConsoleFragment
    }
    instagramAds {
      ...InstagramAdsFragment
    }
    linkedInAds {
      ...linkedInAdsFragment
    }
    microsoftAds {
      ...microsoftAdsFragment
    }
    sortKey
    tiktokAds {
      ...tiktokAdsFragment
    }
    twitterAds {
      ...twitterAdsFragment
    }
  }
}

Variables

{"accountId": "abc123", "clientId": "xyz789"}

Response

{
  "data": {
    "getClientConnection": {
      "accountId": "xyz789",
      "connectionStatus": ClientConnectionServicesStatus,
      "facebookAds": FacebookAdsConnection,
      "googleAds": GoogleAds,
      "googleAnalytics": GoogleAnalytics,
      "googleAnalytics4": googleAnalytics4,
      "googleMyBusiness": GoogleMyBusiness,
      "googleSearchConsole": GoogleSearchConsole,
      "instagramAds": InstagramAds,
      "linkedInAds": linkedInAds,
      "microsoftAds": microsoftAds,
      "sortKey": "xyz789",
      "tiktokAds": tiktokAds,
      "twitterAds": twitterAds
    }
  }
}

Example

Query

query getComment($accountId: String!, $sortKey: String!) {
  getComment(accountId: $accountId, sortKey: $sortKey) {
    accountId
    commentMethod
    commentTimestamp
    commentTo
    dateCreated
    dateUpdated
    deletedBy
    isDeleted
    mentionedUsers
    message
    revisions
    sortKey
    type
    updatedBy
    user {
      ...UserFragment
    }
    userId
  }
}

Variables

{"accountId": "abc123", "sortKey": "abc123"}

Response

{
  "data": {
    "getComment": {
      "accountId": "xyz789",
      "commentMethod": CommentMethod,
      "commentTimestamp": "xyz789",
      "commentTo": "abc123",
      "dateCreated": "abc123",
      "dateUpdated": "abc123",
      "deletedBy": "abc123",
      "isDeleted": false,
      "mentionedUsers": ["xyz789"],
      "message": "abc123",
      "revisions": 123,
      "sortKey": "abc123",
      "type": CommentType,
      "updatedBy": "abc123",
      "user": User,
      "userId": "xyz789"
    }
  }
}

Example

Query

query getDataAccessControl($accountId: String!, $sortKey: String) {
  getDataAccessControl(accountId: $accountId, sortKey: $sortKey) {
    accessLevel
    accessRole
    accountId
    authEmail
    authId
    dateCreated
    dateUpdated
    invitedUser
    isDeleted
    projectId
    projectName
    provider
    revisions
    service
    sortKey
    status
    userId
  }
}

Variables

{"accountId": "xyz789", "sortKey": "xyz789"}

Response

{
  "data": {
    "getDataAccessControl": {
      "accessLevel": "xyz789",
      "accessRole": ["xyz789"],
      "accountId": "xyz789",
      "authEmail": "abc123",
      "authId": "xyz789",
      "dateCreated": "abc123",
      "dateUpdated": "abc123",
      "invitedUser": "xyz789",
      "isDeleted": false,
      "projectId": "xyz789",
      "projectName": "xyz789",
      "provider": ACCESS_CONTROL_PROVIDER,
      "revisions": 987,
      "service": SERVICE,
      "sortKey": "xyz789",
      "status": "abc123",
      "userId": "abc123"
    }
  }
}

Example

Query

query getDataPipeLine($accountId: String!, $sortKey: String) {
  getDataPipeLine(accountId: $accountId, sortKey: $sortKey) {
    accountId
    appliedExtensions {
      ...DataPipelineAppliedExtensionFragment
    }
    changeHistory
    configuration {
      ...DataPipeLineConfigurationFragment
    }
    creditUsed
    dateCreated
    dateLastSyncCompleted
    dateUpdated
    destination {
      ...DestinationFragment
    }
    errorDetails {
      ...PipelineErrorDetailsFragment
    }
    executionName
    extensionCount
    funnelTerms
    hasInitAnalysis
    isArchived
    isDeleted
    isTitleAutoGenerated
    jobType
    log {
      ...DataPipeLineLogFragment
    }
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifyEmail
    notifySlack
    notifyZapier
    report
    revisions
    sortKey
    source {
      ...DataSourceFragment
    }
    status
    title
    totalRowsLoaded
  }
}

Variables

{"accountId": "xyz789", "sortKey": "abc123"}

Response

{
  "data": {
    "getDataPipeLine": {
      "accountId": "xyz789",
      "appliedExtensions": [DataPipelineAppliedExtension],
      "changeHistory": "abc123",
      "configuration": DataPipeLineConfiguration,
      "creditUsed": 987,
      "dateCreated": "xyz789",
      "dateLastSyncCompleted": "abc123",
      "dateUpdated": "xyz789",
      "destination": Destination,
      "errorDetails": PipelineErrorDetails,
      "executionName": "xyz789",
      "extensionCount": 123,
      "funnelTerms": AWSJSON,
      "hasInitAnalysis": true,
      "isArchived": true,
      "isDeleted": true,
      "isTitleAutoGenerated": false,
      "jobType": "xyz789",
      "log": [DataPipeLineLog],
      "notifyConfig": NotifyConfig,
      "notifyEmail": false,
      "notifySlack": false,
      "notifyZapier": false,
      "report": AWSJSON,
      "revisions": 987,
      "sortKey": "xyz789",
      "source": DataSource,
      "status": "abc123",
      "title": "abc123",
      "totalRowsLoaded": 123
    }
  }
}

Example

Query

query getExtension($accountId: String!, $id: String!) {
  getExtension(accountId: $accountId, id: $id) {
    addOnId
    authorImage
    authorLink
    content
    extensionAuthor
    extensionImage
    extensionName
    funnelTerms
    id
    learnMore
    primaryImage
    service
    summary
    termsConditionLink
  }
}

Variables

{"accountId": "abc123", "id": "xyz789"}

Response

{
  "data": {
    "getExtension": {
      "addOnId": "abc123",
      "authorImage": "xyz789",
      "authorLink": "abc123",
      "content": "abc123",
      "extensionAuthor": "abc123",
      "extensionImage": "xyz789",
      "extensionName": "xyz789",
      "funnelTerms": AWSJSON,
      "id": "abc123",
      "learnMore": "xyz789",
      "primaryImage": "xyz789",
      "service": SERVICE,
      "summary": "xyz789",
      "termsConditionLink": "abc123"
    }
  }
}

Example

Query

query getExtensionList($accountId: String!) {
  getExtensionList(accountId: $accountId) {
    addOnId
    authorImage
    authorLink
    content
    extensionAuthor
    extensionImage
    extensionName
    funnelTerms
    id
    learnMore
    primaryImage
    service
    summary
    termsConditionLink
  }
}

Variables

{"accountId": "xyz789"}

Response

{
  "data": {
    "getExtensionList": [
      {
        "addOnId": "abc123",
        "authorImage": "abc123",
        "authorLink": "abc123",
        "content": "abc123",
        "extensionAuthor": "xyz789",
        "extensionImage": "abc123",
        "extensionName": "abc123",
        "funnelTerms": AWSJSON,
        "id": "abc123",
        "learnMore": "xyz789",
        "primaryImage": "abc123",
        "service": SERVICE,
        "summary": "xyz789",
        "termsConditionLink": "xyz789"
      }
    ]
  }
}

Example

Query

query getGA4Properties($accountId: String!, $authId: String, $email: String!, $refresh: Boolean) {
  getGA4Properties(accountId: $accountId, authId: $authId, email: $email, refresh: $refresh) {
    accountId
    accountName
    properties {
      ...GA4PropertyFragment
    }
  }
}

Variables

{"accountId": "abc123", "authId": "xyz789", "email": "abc123", "refresh": true}

Response

{
  "data": {
    "getGA4Properties": [
      {
        "accountId": "xyz789",
        "accountName": "abc123",
        "properties": [GA4Property]
      }
    ]
  }
}

Example

Query

query getGAdsFilter {
  getGAdsFilter {
    campaign {
      ...GAdsCampaignFragment
    }
    label {
      ...GAdsLabelFragment
    }
  }
}

Response

{
  "data": {
    "getGAdsFilter": {
      "campaign": GAdsCampaign,
      "label": GAdsLabel
    }
  }
}

Example

Query

query getGAMetricLists($accountId: String!, $clientId: String!, $refresh: Boolean!, $type: String!) {
  getGAMetricLists(accountId: $accountId, clientId: $clientId, refresh: $refresh, type: $type) {
    items {
      ...MetricsFragment
    }
  }
}

Variables

{"accountId": "xyz789", "clientId": "xyz789", "refresh": true, "type": "xyz789"}

Response

{"data": {"getGAMetricLists": {"items": [Metrics]}}}

Example

Query

query getGASegmentLists($accountId: String!, $clientId: String!, $refresh: Boolean) {
  getGASegmentLists(accountId: $accountId, clientId: $clientId, refresh: $refresh) {
    items {
      ...SegmentsFragment
    }
    status
    statusCode
  }
}

Variables

{"accountId": "xyz789", "clientId": "xyz789", "refresh": false}

Response

{
  "data": {
    "getGASegmentLists": {
      "items": [Segments],
      "status": "abc123",
      "statusCode": 123
    }
  }
}

Example

Query

query getGmbAccountByEmail($accountId: String!, $authId: String, $email: String) {
  getGmbAccountByEmail(accountId: $accountId, authId: $authId, email: $email) {
    accountId
    items {
      ...GmbAccountFragment
    }
  }
}

Variables

{"accountId": "xyz789", "authId": "abc123", "email": "abc123"}

Response

{
  "data": {
    "getGmbAccountByEmail": {
      "accountId": "xyz789",
      "items": [GmbAccount]
    }
  }
}

Example

Query

query getGmbEmails($accountId: String!) {
  getGmbEmails(accountId: $accountId) {
    accountId
    items {
      ...GmbEmailFragment
    }
  }
}

Variables

{"accountId": "xyz789"}

Response

{
  "data": {
    "getGmbEmails": {
      "accountId": "xyz789",
      "items": [GmbEmail]
    }
  }
}

Example

Query

query getGmbLocationByAccount($accountId: String!, $authId: String, $gmbAccountId: String) {
  getGmbLocationByAccount(accountId: $accountId, authId: $authId, gmbAccountId: $gmbAccountId) {
    accountId
    gmbAccountId
    items {
      ...GmbLocationFragment
    }
  }
}

Variables

{"accountId": "abc123", "authId": "xyz789", "gmbAccountId": "abc123"}

Response

{
  "data": {
    "getGmbLocationByAccount": {
      "accountId": "abc123",
      "gmbAccountId": "abc123",
      "items": [GmbLocation]
    }
  }
}

Example

Query

query getGoogleAnalyticsProperties($accountId: String!, $authId: String, $email: String!, $refresh: Boolean) {
  getGoogleAnalyticsProperties(accountId: $accountId, authId: $authId, email: $email, refresh: $refresh) {
    accountId
    accountName
    properties {
      ...GoogleAnalyticsPropertyFragment
    }
  }
}

Variables

{"accountId": "xyz789", "authId": "abc123", "email": "xyz789", "refresh": true}

Response

{
  "data": {
    "getGoogleAnalyticsProperties": [
      {
        "accountId": "xyz789",
        "accountName": "xyz789",
        "properties": [GoogleAnalyticsProperty]
      }
    ]
  }
}

Example

Query

query getGoogleDriveAccounts($accountId: String!, $refresh: Boolean) {
  getGoogleDriveAccounts(accountId: $accountId, refresh: $refresh) {
    accountId
    authId
    email
  }
}

Variables

{"accountId": "abc123", "refresh": false}

Response

{
  "data": {
    "getGoogleDriveAccounts": [
      {"accountId": "abc123", "authId": "xyz789", "email": "abc123"}
    ]
  }
}

Example

Query

query getGoogleSearchConsoleProperties($accountId: String!, $email: String!) {
  getGoogleSearchConsoleProperties(accountId: $accountId, email: $email) {
    domain {
      ...GoogleSearchConsolePropertyFragment
    }
    urlPrefix {
      ...GoogleSearchConsolePropertyFragment
    }
  }
}

Variables

{"accountId": "xyz789", "email": "abc123"}

Response

{
  "data": {
    "getGoogleSearchConsoleProperties": {
      "domain": [GoogleSearchConsoleProperty],
      "urlPrefix": [GoogleSearchConsoleProperty]
    }
  }
}

Example

Query

query getGroupedLocations($accountId: String!, $authId: String!, $email: String, $refresh: Boolean, $service: SERVICE) {
  getGroupedLocations(accountId: $accountId, authId: $authId, email: $email, refresh: $refresh, service: $service) {
    accountId
    accountName
    locations {
      ...LocationFragment
    }
  }
}

Variables

{
  "accountId": "abc123",
  "authId": "abc123",
  "email": "xyz789",
  "refresh": false,
  "service": SERVICE
}

Response

{
  "data": {
    "getGroupedLocations": [
      {
        "accountId": "xyz789",
        "accountName": "abc123",
        "locations": [Location]
      }
    ]
  }
}

Example

Query

query getGscMetricMovement {
  getGscMetricMovement {
    label
    value
  }
}

Response

{"data": {"getGscMetricMovement": [{"label": "xyz789", "value": "xyz789"}]}}

Example

Query

query getInsightDetails($accountId: String!, $clientId: String!, $feature: String, $insightId: String!) {
  getInsightDetails(accountId: $accountId, clientId: $clientId, feature: $feature, insightId: $insightId) {
    accountId
    acknowledgeDateTime
    acknowledgedBy
    acknowledgedMethod
    chartImage
    clientId
    commentCount
    comments {
      ...InsightsCommentFragment
    }
    configuration {
      ...insightsConfigurationFragment
    }
    createdBy
    createdByJobType
    dateCreated
    dateUpdated
    description
    externalId
    fullReportUrl
    graphData {
      ...InsightsGraphFragment
    }
    insightRelatedCount
    isAcknowledged
    isArchived
    isDeleted
    isPartialReport
    isResolved
    jobIcon
    jobId
    jobStatus
    jobTitle
    jobType
    reference
    relatedCountOnCreation
    report
    resolveDateTime
    resolvedBy
    resolvedMethod
    revisions
    service
    slackMessage {
      ...SlackMessageFragment
    }
    sortKey
    summary
    title
    trigger
    watchList
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "feature": "xyz789",
  "insightId": "abc123"
}

Response

{
  "data": {
    "getInsightDetails": {
      "accountId": "abc123",
      "acknowledgeDateTime": "xyz789",
      "acknowledgedBy": ID,
      "acknowledgedMethod": INSIGHTS_METHOD,
      "chartImage": "xyz789",
      "clientId": "xyz789",
      "commentCount": 987,
      "comments": InsightsComment,
      "configuration": insightsConfiguration,
      "createdBy": "abc123",
      "createdByJobType": INSIGHTS_JOBTYPE,
      "dateCreated": "abc123",
      "dateUpdated": "abc123",
      "description": "xyz789",
      "externalId": "abc123",
      "fullReportUrl": "xyz789",
      "graphData": InsightsGraph,
      "insightRelatedCount": 123,
      "isAcknowledged": true,
      "isArchived": false,
      "isDeleted": true,
      "isPartialReport": false,
      "isResolved": true,
      "jobIcon": "abc123",
      "jobId": "xyz789",
      "jobStatus": "abc123",
      "jobTitle": "abc123",
      "jobType": "xyz789",
      "reference": 987,
      "relatedCountOnCreation": 123,
      "report": AWSJSON,
      "resolveDateTime": "abc123",
      "resolvedBy": ID,
      "resolvedMethod": INSIGHTS_METHOD,
      "revisions": 123,
      "service": SERVICE,
      "slackMessage": SlackMessage,
      "sortKey": "abc123",
      "summary": AWSJSON,
      "title": "xyz789",
      "trigger": "abc123",
      "watchList": ["abc123"]
    }
  }
}

Example

Query

query getKPIAdsMetricLists($accountId: String, $clientId: String, $refresh: Boolean, $source: AdsCampaignSource) {
  getKPIAdsMetricLists(accountId: $accountId, clientId: $clientId, refresh: $refresh, source: $source) {
    items {
      ...KPIMetricsFragment
    }
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "refresh": true,
  "source": AdsCampaignSource
}

Response

{
  "data": {
    "getKPIAdsMetricLists": {"items": [KPIMetrics]}
  }
}

Example

Query

query getKPIAdsPreviewReport($input: KPIGAdsPreviewConfigurationInput) {
  getKPIAdsPreviewReport(input: $input) {
    executionArn
    id
    jobStatus
    message
    report {
      ...KPIGAdsReportFragment
    }
    stage
    status
  }
}

Variables

{"input": KPIGAdsPreviewConfigurationInput}

Response

{
  "data": {
    "getKPIAdsPreviewReport": {
      "executionArn": "abc123",
      "id": ID,
      "jobStatus": REPORT_STATUS,
      "message": "abc123",
      "report": KPIGAdsReport,
      "stage": PREVIEW_STAGE,
      "status": KPIPreviewStatus
    }
  }
}

Example

Query

query getKPIDetails($accountId: String!, $sortKey: String!) {
  getKPIDetails(accountId: $accountId, sortKey: $sortKey) {
    accountId
    advancedSettings
    changeHistory
    client {
      ...ClientFragment
    }
    clientId
    clientName
    commentCount
    comments(lastCommentTimestamp: $lastCommentTimestamp, limit: $limit) {
      ...CommentFragment
    }
    configuration {
      ...KPIConfigurationFragment
    }
    connectionStatus
    dateCreated
    dateUpdated
    history
    id
    isArchived
    isDeleted
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifySchedEmail
    notifySchedSlack
    notifySchedWebhook
    report {
      ...KPIReportFragment
    }
    revisions
    schedEmail
    schedSlack
    schedWebhook
    service
    sortKey
    title
    user {
      ...UserFragment
    }
    userId
    watchList
    webhookEvents
    webhookURL
  }
}

Variables

{"accountId": "xyz789", "sortKey": "xyz789"}

Response

{
  "data": {
    "getKPIDetails": {
      "accountId": "abc123",
      "advancedSettings": AWSJSON,
      "changeHistory": "xyz789",
      "client": Client,
      "clientId": "abc123",
      "clientName": "abc123",
      "commentCount": 987,
      "comments": [Comment],
      "configuration": KPIConfiguration,
      "connectionStatus": "abc123",
      "dateCreated": "xyz789",
      "dateUpdated": "xyz789",
      "history": AWSJSON,
      "id": "abc123",
      "isArchived": true,
      "isDeleted": false,
      "jobStatus": REPORT_STATUS,
      "jobType": "abc123",
      "notifyConfig": NotifyConfig,
      "notifySchedEmail": "xyz789",
      "notifySchedSlack": "xyz789",
      "notifySchedWebhook": "xyz789",
      "report": KPIReport,
      "revisions": 987,
      "schedEmail": "xyz789",
      "schedSlack": "xyz789",
      "schedWebhook": "abc123",
      "service": SERVICE,
      "sortKey": "xyz789",
      "title": "abc123",
      "user": User,
      "userId": "abc123",
      "watchList": ["abc123"],
      "webhookEvents": [WEBHOOK_ENUM],
      "webhookURL": "xyz789"
    }
  }
}

Example

Query

query getKPIPreviewReport($input: KPIPreviewConfigurationInput) {
  getKPIPreviewReport(input: $input) {
    errorMessage
    executionArn
    id
    jobStatus
    message
    report {
      ...KPIReportFragment
    }
    stage
    status
  }
}

Variables

{"input": KPIPreviewConfigurationInput}

Response

{
  "data": {
    "getKPIPreviewReport": {
      "errorMessage": AWSJSON,
      "executionArn": "xyz789",
      "id": ID,
      "jobStatus": REPORT_STATUS,
      "message": "abc123",
      "report": KPIReport,
      "stage": PREVIEW_STAGE,
      "status": KPIPreviewStatus
    }
  }
}

Example

Query

query getKPISpreadsheetPreviewReport($input: KPISpreadsheetPreviewConfigurationInput) {
  getKPISpreadsheetPreviewReport(input: $input) {
    executionArn
    id
    jobStatus
    message
    report {
      ...KPIGAdsReportFragment
    }
    stage
    status
  }
}

Variables

{"input": KPISpreadsheetPreviewConfigurationInput}

Response

{
  "data": {
    "getKPISpreadsheetPreviewReport": {
      "executionArn": "xyz789",
      "id": ID,
      "jobStatus": REPORT_STATUS,
      "message": "abc123",
      "report": KPIGAdsReport,
      "stage": PREVIEW_STAGE,
      "status": KPIPreviewStatus
    }
  }
}

Example

Query

query getLabel($accountId: String!, $sortKey: String!) {
  getLabel(accountId: $accountId, sortKey: $sortKey) {
    accountId
    clientList
    label
    revisions
    selected
    sortKey
  }
}

Variables

{"accountId": "xyz789", "sortKey": "xyz789"}

Response

{
  "data": {
    "getLabel": {
      "accountId": "abc123",
      "clientList": ["abc123"],
      "label": "abc123",
      "revisions": 987,
      "selected": false,
      "sortKey": "abc123"
    }
  }
}

Example

Query

query getLabels($accountId: String!) {
  getLabels(accountId: $accountId) {
    accountId
    clientList
    label
    revisions
    selected
    sortKey
  }
}

Variables

{"accountId": "abc123"}

Response

{
  "data": {
    "getLabels": [
      {
        "accountId": "abc123",
        "clientList": ["xyz789"],
        "label": "xyz789",
        "revisions": 987,
        "selected": true,
        "sortKey": "abc123"
      }
    ]
  }
}

Example

Query

query getLabelsForUser($accountId: String!, $cognitoUserId: String!) {
  getLabelsForUser(accountId: $accountId, cognitoUserId: $cognitoUserId) {
    accountId
    clientList
    label
    revisions
    selected
    sortKey
  }
}

Variables

{"accountId": "abc123", "cognitoUserId": "xyz789"}

Response

{
  "data": {
    "getLabelsForUser": [
      {
        "accountId": "abc123",
        "clientList": ["xyz789"],
        "label": "xyz789",
        "revisions": 987,
        "selected": false,
        "sortKey": "xyz789"
      }
    ]
  }
}

Example

Query

query getMetrics($accountId: String, $clientId: String, $refresh: Boolean, $source: AdsCampaignSource) {
  getMetrics(accountId: $accountId, clientId: $clientId, refresh: $refresh, source: $source) {
    items {
      ...KPIMetricsFragment
    }
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "refresh": false,
  "source": AdsCampaignSource
}

Response

{"data": {"getMetrics": {"items": [KPIMetrics]}}}

Example

Query

query getPipelineExtension($accountId: String!, $extensionId: String!, $pipelineId: String!) {
  getPipelineExtension(accountId: $accountId, extensionId: $extensionId, pipelineId: $pipelineId) {
    accountId
    extensionId
    pipelineId
    properties {
      ...PipelineExtensionPropertiesFragment
    }
  }
}

Variables

{"accountId": "abc123", "extensionId": "xyz789", "pipelineId": "xyz789"}

Response

{
  "data": {
    "getPipelineExtension": {
      "accountId": "xyz789",
      "extensionId": "abc123",
      "pipelineId": "xyz789",
      "properties": [PipelineExtensionProperties]
    }
  }
}

Example

Query

query getRelatedInsights($accountId: String!, $clientId: String!, $createdBy: String!, $feature: String!, $isResolved: Boolean, $nextToken: String, $sortKey: String) {
  getRelatedInsights(accountId: $accountId, clientId: $clientId, createdBy: $createdBy, feature: $feature, isResolved: $isResolved, nextToken: $nextToken, sortKey: $sortKey) {
    active
    items {
      ...InsightsFragment
    }
    nextToken
    resolved
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "createdBy": "xyz789",
  "feature": "xyz789",
  "isResolved": true,
  "nextToken": "xyz789",
  "sortKey": "xyz789"
}

Response

{
  "data": {
    "getRelatedInsights": {
      "active": 987,
      "items": [Insights],
      "nextToken": "abc123",
      "resolved": 123
    }
  }
}

Example

Query

query getSavedFilters($accountId: String!, $cognitoUserId: String!) {
  getSavedFilters(accountId: $accountId, cognitoUserId: $cognitoUserId) {
    id
    label
  }
}

Variables

{"accountId": "abc123", "cognitoUserId": "abc123"}

Response

{"data": {"getSavedFilters": [{"id": "abc123", "label": "abc123"}]}}

Example

Query

query getSlackChannelList($accountId: String!, $authId: String!, $refresh: Boolean) {
  getSlackChannelList(accountId: $accountId, authId: $authId, refresh: $refresh) {
    id
    name
  }
}

Variables

{"accountId": "abc123", "authId": "abc123", "refresh": true}

Response

{"data": {"getSlackChannelList": [{"id": "xyz789", "name": "xyz789"}]}}

Example

Query

query getSubscriptionInvoiceEstimate($accountId: String!) {
  getSubscriptionInvoiceEstimate(accountId: $accountId) {
    currency
    description
    inclusion {
      ...OutputInclusionFragment
    }
    lineItems {
      ...SubscriptionInvoiceEstimateItemFragment
    }
    total
  }
}

Variables

{"accountId": "abc123"}

Response

{
  "data": {
    "getSubscriptionInvoiceEstimate": {
      "currency": "abc123",
      "description": "abc123",
      "inclusion": [OutputInclusion],
      "lineItems": [SubscriptionInvoiceEstimateItem],
      "total": "xyz789"
    }
  }
}

Example

Query

query getTimeZones($partitionKey: String!) {
  getTimeZones(partitionKey: $partitionKey) {
    enum
  }
}

Variables

{"partitionKey": "xyz789"}

Response

{"data": {"getTimeZones": {"enum": ["abc123"]}}}

Example

Query

query getUpvotyJWT($accountId: String!, $email: String!, $userId: String!) {
  getUpvotyJWT(accountId: $accountId, email: $email, userId: $userId) {
    token
  }
}

Variables

{"accountId": "abc123", "email": "abc123", "userId": "xyz789"}

Response

{"data": {"getUpvotyJWT": {"token": "xyz789"}}}

Example

Query

query getUserPreferences($accountId: String!, $cognitoUserId: String!) {
  getUserPreferences(accountId: $accountId, cognitoUserId: $cognitoUserId) {
    accountId
    preferences {
      ...UserPreferencesOutputFragment
    }
    sortKey
  }
}

Variables

{"accountId": "abc123", "cognitoUserId": "xyz789"}

Response

{
  "data": {
    "getUserPreferences": {
      "accountId": "abc123",
      "preferences": UserPreferencesOutput,
      "sortKey": "xyz789"
    }
  }
}

Example

Query

query getUsers($accountId: String!, $cognitoUserId: String!, $nextToken: String) {
  getUsers(accountId: $accountId, cognitoUserId: $cognitoUserId, nextToken: $nextToken) {
    items {
      ...UserFragment
    }
    nextToken
    scannedCount
  }
}

Variables

{"accountId": "abc123", "cognitoUserId": "abc123", "nextToken": "xyz789"}

Response

{
  "data": {
    "getUsers": {
      "items": [User],
      "nextToken": "xyz789",
      "scannedCount": 987
    }
  }
}

Example

Query

query latestInsightsUnderAccount($accountId: String!, $clientId: String, $filters: [labelInput], $isResolved: Boolean, $type: String) {
  latestInsightsUnderAccount(accountId: $accountId, clientId: $clientId, filters: $filters, isResolved: $isResolved, type: $type) {
    count
    id
    items {
      ...InsightsFragment
    }
    nextToken
    scannedCount
  }
}

Variables

{
  "accountId": "abc123",
  "clientId": "abc123",
  "filters": [labelInput],
  "isResolved": true,
  "type": "xyz789"
}

Response

{
  "data": {
    "latestInsightsUnderAccount": {
      "count": 123,
      "id": "abc123",
      "items": [Insights],
      "nextToken": "xyz789",
      "scannedCount": 987
    }
  }
}

Example

Query

query latestInsightsUnderClient($accountId: String!, $clientId: String!, $isResolved: Boolean, $jobId: String, $type: String) {
  latestInsightsUnderClient(accountId: $accountId, clientId: $clientId, isResolved: $isResolved, jobId: $jobId, type: $type) {
    count
    id
    items {
      ...InsightsFragment
    }
    nextToken
    scannedCount
  }
}

Variables

{
  "accountId": "abc123",
  "clientId": "xyz789",
  "isResolved": true,
  "jobId": "xyz789",
  "type": "xyz789"
}

Response

{
  "data": {
    "latestInsightsUnderClient": {
      "count": 123,
      "id": "xyz789",
      "items": [Insights],
      "nextToken": "abc123",
      "scannedCount": 123
    }
  }
}

Example

Query

query listAccountConnections($accountId: String!) {
  listAccountConnections(accountId: $accountId) {
    items {
      ...AccountConnectionFragment
    }
    nextToken
    scannedCount
  }
}

Variables

{"accountId": "xyz789"}

Response

{
  "data": {
    "listAccountConnections": {
      "items": [AccountConnection],
      "nextToken": "xyz789",
      "scannedCount": 123
    }
  }
}

Example

Query

query listAdsCampaigns($accountId: String!, $clientId: String!, $refresh: Boolean!, $source: AdsCampaignSource) {
  listAdsCampaigns(accountId: $accountId, clientId: $clientId, refresh: $refresh, source: $source) {
    advertisingChannelType
    baseCampaign
    campaignBudget
    endDate
    id
    name
    servingStatus
    startDate
    status
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "xyz789",
  "refresh": false,
  "source": AdsCampaignSource
}

Response

{
  "data": {
    "listAdsCampaigns": [
      {
        "advertisingChannelType": "abc123",
        "baseCampaign": "abc123",
        "campaignBudget": "abc123",
        "endDate": "xyz789",
        "id": "xyz789",
        "name": "xyz789",
        "servingStatus": "xyz789",
        "startDate": "xyz789",
        "status": "abc123"
      }
    ]
  }
}

Example

Query

query listAllClients($accountId: ID!, $count: Int, $isArchived: Boolean, $nextToken: String) {
  listAllClients(accountId: $accountId, count: $count, isArchived: $isArchived, nextToken: $nextToken) {
    count
    isClientSubscriptionValid
    isNearSubscriptionLimit
    items {
      ...ClientFragment
    }
    nextToken
    totalAnomaliesUnderAccount
    totalBudgetsUnderAccount
    totalKPISUnderAccount
  }
}

Variables

{
  "accountId": ID,
  "count": 987,
  "isArchived": false,
  "nextToken": "xyz789"
}

Response

{
  "data": {
    "listAllClients": {
      "count": 123,
      "isClientSubscriptionValid": false,
      "isNearSubscriptionLimit": false,
      "items": [Client],
      "nextToken": "abc123",
      "totalAnomaliesUnderAccount": 987,
      "totalBudgetsUnderAccount": 123,
      "totalKPISUnderAccount": 987
    }
  }
}

Example

Query

query listAnomalyUnderAccount($accountId: String!, $count: Int, $filters: [labelInput], $isArchived: Boolean!, $nextToken: String) {
  listAnomalyUnderAccount(accountId: $accountId, count: $count, filters: $filters, isArchived: $isArchived, nextToken: $nextToken) {
    count
    currentAccountSubscriptionValue
    isNearSubscriptionLimit
    items {
      ...AnomalyFragment
    }
    nextToken
    scannedCount
    totalSubscription
  }
}

Variables

{
  "accountId": "xyz789",
  "count": 987,
  "filters": [labelInput],
  "isArchived": true,
  "nextToken": "abc123"
}

Response

{
  "data": {
    "listAnomalyUnderAccount": {
      "count": 987,
      "currentAccountSubscriptionValue": 123,
      "isNearSubscriptionLimit": true,
      "items": [Anomaly],
      "nextToken": "xyz789",
      "scannedCount": 987,
      "totalSubscription": 987
    }
  }
}

Example

Query

query listAnomalyUnderClient($accountId: String!, $clientId: String!, $count: Int, $isArchived: Boolean!, $nextToken: String) {
  listAnomalyUnderClient(accountId: $accountId, clientId: $clientId, count: $count, isArchived: $isArchived, nextToken: $nextToken) {
    count
    currentAccountSubscriptionValue
    isNearSubscriptionLimit
    items {
      ...AnomalyFragment
    }
    nextToken
    scannedCount
    totalSubscription
  }
}

Variables

{
  "accountId": "abc123",
  "clientId": "xyz789",
  "count": 987,
  "isArchived": false,
  "nextToken": "xyz789"
}

Response

{
  "data": {
    "listAnomalyUnderClient": {
      "count": 123,
      "currentAccountSubscriptionValue": 987,
      "isNearSubscriptionLimit": true,
      "items": [Anomaly],
      "nextToken": "abc123",
      "scannedCount": 123,
      "totalSubscription": 123
    }
  }
}

Example

Query

query listAutomationUnderAccount($accountId: String!, $count: Int, $filters: [labelInput], $isArchived: Boolean!, $nextToken: String) {
  listAutomationUnderAccount(accountId: $accountId, count: $count, filters: $filters, isArchived: $isArchived, nextToken: $nextToken) {
    accountId
    clientId
    clientName
    cognitoUserId
    configuration
    connectionStatus
    dateLastInsightCreated
    dateLastRun
    executionArn
    gmbLocationId
    isArchived
    isDeleted
    jobId
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifyEmail
    notifySlack
    notifyWebhook
    revisions
    service
    sortKey
    title
    webhookURL
  }
}

Variables

{
  "accountId": "abc123",
  "count": 123,
  "filters": [labelInput],
  "isArchived": false,
  "nextToken": "xyz789"
}

Response

{
  "data": {
    "listAutomationUnderAccount": [
      {
        "accountId": "xyz789",
        "clientId": "abc123",
        "clientName": "abc123",
        "cognitoUserId": "xyz789",
        "configuration": AWSJSON,
        "connectionStatus": "xyz789",
        "dateLastInsightCreated": "xyz789",
        "dateLastRun": "abc123",
        "executionArn": "abc123",
        "gmbLocationId": "xyz789",
        "isArchived": true,
        "isDeleted": true,
        "jobId": "abc123",
        "jobStatus": ANOMALY_STATUS,
        "jobType": "xyz789",
        "notifyConfig": NotifyConfig,
        "notifyEmail": true,
        "notifySlack": true,
        "notifyWebhook": false,
        "revisions": 123,
        "service": SERVICE,
        "sortKey": "xyz789",
        "title": "xyz789",
        "webhookURL": "xyz789"
      }
    ]
  }
}

Example

Query

query listAutomationUnderClient($accountId: String!, $clientId: String!, $count: Int, $isArchived: Boolean!, $nextToken: String) {
  listAutomationUnderClient(accountId: $accountId, clientId: $clientId, count: $count, isArchived: $isArchived, nextToken: $nextToken) {
    accountId
    clientId
    clientName
    cognitoUserId
    configuration
    connectionStatus
    dateLastInsightCreated
    dateLastRun
    executionArn
    gmbLocationId
    isArchived
    isDeleted
    jobId
    jobStatus
    jobType
    notifyConfig {
      ...NotifyConfigFragment
    }
    notifyEmail
    notifySlack
    notifyWebhook
    revisions
    service
    sortKey
    title
    webhookURL
  }
}

Variables

{
  "accountId": "xyz789",
  "clientId": "abc123",
  "count": 123,
  "isArchived": false,
  "nextToken": "abc123"
}

Response

{
  "data": {
    "listAutomationUnderClient": [
      {
        "accountId": "abc123",
        "clientId": "xyz789",
        "clientName": "abc123",
        "cognitoUserId": "abc123",
        "configuration": AWSJSON,
        "connectionStatus": "xyz789",
        "dateLastInsightCreated": "xyz789",
        "dateLastRun": "abc123",
        "executionArn": "xyz789",
        "gmbLocationId": "abc123",
        "isArchived": false,
        "isDeleted": true,
        "jobId": "abc123",
        "jobStatus": ANOMALY_STATUS,
        "jobType": "xyz789",
        "notifyConfig": NotifyConfig,
        "notifyEmail": true,
        "notifySlack": true,
        "notifyWebhook": false,
        "revisions": 987,
        "service": SERVICE,
        "sortKey": "abc123",
        "title": "abc123",
        "webhookURL": "xyz789"
      }
    ]
  }
}

Example

Query

query listBudgetUnderAccount($accountId: String!, $clientId: String, $count: Int, $filters: [labelInput], $isArchived: Boolean!, $jobStatus: String, $nextToken: String, $service: String) {
  listBudgetUnderAccount(accountId: $accountId, clientId: $clientId, count: $count, filters: $filters, isArchived: $isArchived, jobStatus: $jobStatus, nextToken: $nextToken, service: $service) {
    count
    currentAccountSubscriptionValue
    isNearSubscriptionLimit
    items {
      ...BudgetFragment
    }
    nextToken
    scannedCount
    totalSubscription
  }
}

Variables

{
  "accountId": "abc123",
  "clientId": "xyz789",
  "count": 987,
  "filters": [labelInput],
  "isArchived": true,
  "jobStatus": "xyz789",
  "nextToken": "abc123",
  "service": "xyz789"
}

Response

{
  "data": {
    "listBudgetUnderAccount": {
      "count": 123,
      "currentAccountSubscriptionValue": 123,
      "isNearSubscriptionLimit": true,
      "items": [Budget],
      "nextToken": "xyz789",
      "scannedCount": 123,
      "totalSubscription": 123
    }
  }
}

Example

Query

query listBudgetUnderClient($accountId: String!, $clientId: String!, $count: Int, $isArchived: Boolean!, $jobStatus: String, $nextToken: String, $service: String) {
  listBudgetUnderClient(accountId: $accountId, clientId: $clientId, count: $count, isArchived: $isArchived, jobStatus: $jobStatus, nextToken: $nextToken, service: $service) {
    count
    currentAccountSubscriptionValue
    isNearSubscriptionLimit
    items {
      ...BudgetFragment
    }
    nextToken
    scannedCount
    totalSubscription
  }
}

Variables

{
  "accountId": "abc123",
  "clientId": "abc123",
  "count": 987,
  "isArchived": false,
  "jobStatus": "xyz789",
  "nextToken": "abc123",
  "service": "xyz789"
}

Response

{
  "data": {
    "listBudgetUnderClient": {
      "count": 987,
      "currentAccountSubscriptionValue": 123,
      "isNearSubscriptionLimit": true,
      "items": [Budget],
      "nextToken": "xyz789",
      "scannedCount": 987,
      "totalSubscription": 987
    }
  }
}

Example

Query

query listClients($accountId: ID!, $count: Int, $filters: [labelInput], $isArchived: Boolean, $nextToken: String) {
  listClients(accountId: $accountId, count: $count, filters: $filters, isArchived: $isArchived, nextToken: $nextToken) {
    count
    isClientSubscriptionValid
    isNearSubscriptionLimit
    items {
      ...ClientFragment
    }
    nextToken
    totalAnomaliesUnderAccount
    totalBudgetsUnderAccount
    totalKPISUnderAccount
  }
}

Variables

{
  "accountId": ID,
  "count": 987,
  "filters": [labelInput],
  "isArchived": false,
  "nextToken": "xyz789"
}

Response

{
  "data": {
    "listClients": {
      "count": 123,
      "isClientSubscriptionValid": true,
      "isNearSubscriptionLimit": true,
      "items": [Client],
      "nextToken": "abc123",
      "totalAnomaliesUnderAccount": 123,
      "totalBudgetsUnderAccount": 123,
      "totalKPISUnderAccount": 123
    }
  }
}

Example

Query

query listClientsForLabel($accountId: String!, $labelId: String!) {
  listClientsForLabel(accountId: $accountId, labelId: $labelId) {
    accountId
    hasLabel
    name
    sortKey
  }
}

Variables

{"accountId": "xyz789", "labelId": "xyz789"}

Response

{
  "data": {
    "listClientsForLabel": [
      {
        "accountId": "abc123",
        "hasLabel": true,
        "name": "xyz789",
        "sortKey": "xyz789"
      }
    ]
  }
}

Example

Query

query listComments($input: ListCommentInput) {
  listComments(input: $input) {
    accountId
    commentMethod
    commentTimestamp
    commentTo
    dateCreated
    dateUpdated
    deletedBy
    isDeleted
    mentionedUsers
    message
    revisions
    sortKey
    type
    updatedBy
    user {
      ...UserFragment
    }
    userId
  }
}

Variables

{"input": ListCommentInput}

Response

{
  "data": {
    "listComments": [
      {
        "accountId": "xyz789",
        "commentMethod": CommentMethod,
        "commentTimestamp": "xyz789",
        "commentTo": "xyz789",
        "dateCreated": "xyz789",
        "dateUpdated": "abc123",
        "deletedBy": "xyz789",
        "isDeleted": true,
        "mentionedUsers": ["abc123"],
        "message": "xyz789",
        "revisions": 987,
        "sortKey": "xyz789",
        "type": CommentType,
        "updatedBy": "xyz789",
        "user": User,
        "userId": "xyz789"
      }
    ]
  }
}

Example

Query

query listDataAccessControls($accountId: String!, $cognitoUserId: String, $nextToken: String) {
  listDataAccessControls(accountId: $accountId, cognitoUserId: $cognitoUserId, nextToken: $nextToken) {
    items {
      ...DataAccessControlFragment
    }
    nextToken
  }
}

Variables

{"accountId": "xyz789", "cognitoUserId": "abc123", "nextToken": "xyz789"}

Response

{
  "data": {
    "listDataAccessControls": {
      "items": [DataAccessControl],
      "nextToken": "xyz789"
    }
  }
}