Get conversation analytics

veryfront__get_conversation_analytics

Requires account.billing.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
presetstringNoWhole local days, defaulting to 30d. Explicit from/to bounds take precedence over preset, including SDK-supplied defaults. Default: "30d". Values: "7d", "30d", "90d".
fromstringNoInclusive start. Supply both from and to; these bounds take precedence over preset. Format: date-time.
tostringNoExclusive end, no later than the end of today in timezone.
timezonestringNoProvide the timezone. Default: "UTC".
granularitystringNoUTC hours, or local calendar days, Monday-based weeks and months. Default: "day". Values: "hour", "day", "week", "month".
group_bystring[]NoGrouping dimensions supported by this operation. Repeat the parameter or use a comma-separated list.
comparestringNoCompare preceding calendar months for whole-month custom ranges, local days for whole-day ranges and presets, or equal elapsed duration otherwise. Value: "previous_period".
labelstring[]NoProvide the label.
project_referencestringNoProject ID or slug that narrows the read to one project of the account. A project of another account is not found. Minimum length: 1.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__get_conversation_analytics",
    "arguments": {}
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
scopeobject or objectNo
group_bystring[]No
summaryobjectYesStructured summary details associated with this tool result.
timeframeobjectYesStructured timeframe details associated with this tool result.
seriesobject[]YesList of series associated with this tool result.
statusesobject[]YesList of statuses associated with this tool result.
modelsobject[]YesList of models associated with this tool result.
toolsobject[]YesList of tools associated with this tool result.
projectsobject[]YesList of projects associated with this tool result.
recent_conversationsobject[]YesList of recent conversations associated with this tool result.

Full schemas

json
{
  "type": "object",
  "properties": {
    "preset": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d"
      ],
      "description": "Whole local days, defaulting to 30d. Explicit from/to bounds take precedence over preset, including SDK-supplied defaults.",
      "default": "30d"
    },
    "from": {
      "type": "string",
      "format": "date-time",
      "description": "Inclusive start. Supply both from and to; these bounds take precedence over preset."
    },
    "to": {
      "$ref": "#/properties/from",
      "description": "Exclusive end, no later than the end of today in timezone."
    },
    "timezone": {
      "type": "string",
      "description": "Provide the timezone.",
      "default": "UTC"
    },
    "granularity": {
      "type": "string",
      "enum": [
        "hour",
        "day",
        "week",
        "month"
      ],
      "description": "UTC hours, or local calendar days, Monday-based weeks and months.",
      "default": "day"
    },
    "group_by": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "project",
          "model",
          "api_key",
          "member"
        ],
        "description": "One group by item supplied to the tool."
      },
      "maxItems": 4,
      "description": "Grouping dimensions supported by this operation. Repeat the parameter or use a comma-separated list."
    },
    "compare": {
      "type": "string",
      "const": "previous_period",
      "description": "Compare preceding calendar months for whole-month custom ranges, local days for whole-day ranges and presets, or equal elapsed duration otherwise."
    },
    "label": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "One label item supplied to the tool."
      },
      "description": "Provide the label."
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug that narrows the read to one project of the account. A project of another account is not found."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the get_conversation_analytics tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "scope": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "account"
            },
            "account_id": {
              "type": "string",
              "format": "uuid"
            },
            "project_id": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uuid",
                  "description": "Project identifier associated with this result."
                },
                {
                  "type": "null",
                  "description": "Project identifier associated with this result."
                }
              ],
              "description": "Project identifier associated with this result."
            }
          },
          "required": [
            "kind",
            "account_id",
            "project_id"
          ],
          "additionalProperties": false,
          "description": "Structured option 1 details associated with this tool result."
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "user"
            },
            "user_id": {
              "type": "string",
              "format": "uuid"
            },
            "project_id": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uuid",
                  "description": "Project identifier associated with this result."
                },
                {
                  "type": "null",
                  "description": "Project identifier associated with this result."
                }
              ],
              "description": "Project identifier associated with this result."
            }
          },
          "required": [
            "kind",
            "user_id",
            "project_id"
          ],
          "additionalProperties": false,
          "description": "Structured option 2 details associated with this tool result."
        }
      ]
    },
    "group_by": {
      "type": "array",
      "items": {
        "type": "string",
        "const": "project"
      }
    },
    "summary": {
      "type": "object",
      "properties": {
        "total_conversations": {
          "type": "number",
          "description": "Conversations created in the selected interval."
        },
        "active_conversations": {
          "type": "number",
          "description": "Matching conversations currently active."
        },
        "total_messages": {
          "type": "number",
          "description": "Current stored message counters of matching conversations."
        },
        "last_conversation_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "Latest activity of matching conversations."
        },
        "previous": {
          "type": "object",
          "properties": {
            "total_conversations": {
              "$ref": "#/properties/summary/properties/total_conversations",
              "description": "The total conversations returned by the tool."
            },
            "active_conversations": {
              "$ref": "#/properties/summary/properties/active_conversations",
              "description": "The active conversations returned by the tool."
            },
            "total_messages": {
              "$ref": "#/properties/summary/properties/total_messages",
              "description": "The total messages returned by the tool."
            },
            "last_conversation_at": {
              "$ref": "#/properties/summary/properties/last_conversation_at",
              "description": "The last conversation at returned by the tool."
            }
          },
          "required": [
            "total_conversations",
            "active_conversations",
            "total_messages",
            "last_conversation_at"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "total_conversations",
        "active_conversations",
        "total_messages",
        "last_conversation_at"
      ],
      "additionalProperties": false,
      "description": "Structured summary details associated with this tool result."
    },
    "timeframe": {
      "type": "object",
      "properties": {
        "from": {
          "type": "string",
          "format": "date-time",
          "description": "Inclusive start."
        },
        "to": {
          "type": "string",
          "format": "date-time",
          "description": "Exclusive end."
        },
        "timezone": {
          "type": "string"
        },
        "granularity": {
          "type": "string",
          "enum": [
            "hour",
            "day",
            "week",
            "month"
          ]
        },
        "bucket_count": {
          "type": "integer",
          "minimum": 0
        },
        "previous": {
          "type": "object",
          "properties": {
            "from": {
              "$ref": "#/properties/timeframe/properties/from",
              "description": "The from returned by the tool."
            },
            "to": {
              "$ref": "#/properties/timeframe/properties/to",
              "description": "The to returned by the tool."
            },
            "timezone": {
              "$ref": "#/properties/timeframe/properties/timezone",
              "description": "The timezone returned by the tool."
            },
            "granularity": {
              "$ref": "#/properties/timeframe/properties/granularity",
              "description": "The granularity returned by the tool."
            },
            "bucket_count": {
              "$ref": "#/properties/timeframe/properties/bucket_count",
              "description": "The bucket count returned by the tool."
            }
          },
          "required": [
            "from",
            "to",
            "timezone",
            "granularity",
            "bucket_count"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "from",
        "to",
        "timezone",
        "granularity",
        "bucket_count"
      ],
      "additionalProperties": false,
      "description": "Structured timeframe details associated with this tool result."
    },
    "series": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "conversations": {
            "type": "number"
          },
          "messages": {
            "type": "number"
          },
          "bucket_start": {
            "type": "string"
          },
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "conversations": {
                  "$ref": "#/properties/series/items/properties/conversations",
                  "description": "The conversations returned by the tool."
                },
                "messages": {
                  "$ref": "#/properties/series/items/properties/messages",
                  "description": "The messages returned by the tool."
                },
                "dimensions": {
                  "type": "object",
                  "properties": {
                    "project_id": {
                      "anyOf": [
                        {
                          "type": "string",
                          "format": "uuid",
                          "description": "Project identifier associated with this result."
                        },
                        {
                          "type": "null",
                          "description": "Project identifier associated with this result."
                        }
                      ],
                      "description": "Project identifier associated with this result."
                    }
                  },
                  "required": [
                    "project_id"
                  ],
                  "additionalProperties": false,
                  "description": "Structured dimensions details associated with this tool result."
                }
              },
              "required": [
                "conversations",
                "messages",
                "dimensions"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "conversations",
          "messages",
          "bucket_start"
        ],
        "additionalProperties": false
      },
      "description": "List of series associated with this tool result."
    },
    "statuses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Lifecycle status for the returned record."
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "status",
          "count"
        ],
        "additionalProperties": false
      },
      "description": "List of statuses associated with this tool result."
    },
    "models": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "provider": {
            "type": "string"
          },
          "model": {
            "type": "string",
            "description": "AI model id associated with this tool result."
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "provider",
          "model",
          "count"
        ],
        "additionalProperties": false
      },
      "description": "List of models associated with this tool result."
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "name",
          "count"
        ],
        "additionalProperties": false
      },
      "description": "List of tools associated with this tool result."
    },
    "projects": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "project_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "Project identifier associated with this result."
              },
              {
                "type": "null",
                "description": "Project identifier associated with this result."
              }
            ],
            "description": "Project identifier associated with this result."
          },
          "project_name": {
            "type": "string"
          },
          "project_slug": {
            "type": [
              "string",
              "null"
            ]
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "project_id",
          "project_name",
          "project_slug",
          "count"
        ],
        "additionalProperties": false
      },
      "description": "List of projects associated with this tool result."
    },
    "recent_conversations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "conversation_id": {
            "type": "string",
            "format": "uuid",
            "description": "Conversation identifier associated with this result."
          },
          "title": {
            "type": [
              "string",
              "null"
            ],
            "description": "Short human-readable title returned by the tool."
          },
          "status": {
            "type": "string",
            "description": "Lifecycle status for the returned record."
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "Project identifier associated with this result."
              },
              {
                "type": "null",
                "description": "Project identifier associated with this result."
              }
            ],
            "description": "Project identifier associated with this result."
          },
          "project_name": {
            "type": "string"
          },
          "project_slug": {
            "type": [
              "string",
              "null"
            ]
          },
          "last_activity_at": {
            "type": "string"
          }
        },
        "required": [
          "conversation_id",
          "title",
          "status",
          "project_id",
          "project_name",
          "project_slug",
          "last_activity_at"
        ],
        "additionalProperties": false
      },
      "description": "List of recent conversations associated with this tool result."
    }
  },
  "required": [
    "summary",
    "timeframe",
    "series",
    "statuses",
    "models",
    "tools",
    "projects",
    "recent_conversations"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_conversation_analytics tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}