Analytics

GET /public/v1/analytics/overview

Get workspace-level analytics totals and per-campaign breakdown. Workspace admins and owners see all campaigns in the workspace, Workspace members see only their own campaigns.

GET /public/v1/analytics/overview

GET /public/v1/analytics/overview

curl --request GET \
  --url 'https://api.joinvalley.co/public/v1/analytics/overview' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "statusCode": 1,
  "status": true,
  "message": "<string>",
  "data": {
    "overview": {
      "workspaceId": "<string>",
      "timeSeries": [
        {}
      ],
      "totals": {
        "prospectsContacted": 1,
        "inMailsSent": 1,
        "messagingSent": 1,
        "acceptedConnections": 1,
        "repliesReceived": 1,
        "meetingsBooked": 1,
        "interestedProspects": 1
      },
      "byCampaign": [
        {}
      ]
    }
  }
}

Default Response

Authorizations

  • x-api-key string required header

    Your Valley API key.

Query Parameters

  • endDate string

    Required. End of the date range in YYYY-MM-DD format (e.g. 2026-01-31). Must be on or after startDate.

  • granularity string enum

    Time bucket size for the time series. Defaults to day.

  • group_by string enum

    Dimension to group results by. Currently only "campaign" is supported.

  • ownerId string

    Admin/Owner only: scope results to a specific workspace member by their user ID.

  • startDate string

    Required. Start of the date range in YYYY-MM-DD format (e.g. 2026-01-01).

  • workspaceId string

    Required. The workspace to scope the analytics to. Admins and owners see all campaigns; members see only their own.

Response

application/json
  • statusCode number
  • status boolean
  • message string
  • data object
    + Show Child Attributes
    • overview object
      + Show Child Attributes
      • workspaceId string
      • timeSeries[] object array
        + Show Child Attributes
        • date string
        • inMailsSent number
        • connectionRequestsSent number
        • followUpsSent number
        • reEngagementSent number
        • repliesReceived number
        • meetingsBooked number
      • totals object
        + Show Child Attributes
        • prospectsContacted number
        • inMailsSent number
        • messagingSent number
        • acceptedConnections number
        • repliesReceived number
        • meetingsBooked number
        • interestedProspects number
      • byCampaign[] object array
        + Show Child Attributes
        • campaignId string
        • campaignName string
        • prospectsContacted number
        • inMailsSent number
        • messagingSent number
        • acceptedConnections number
        • repliesReceived number
        • meetingsBooked number
        • interestedProspects number
        • icpFit object
          + Show Child Attributes
          • totalUnique number
          • lowIcpCount number
          • mediumIcpCount number
          • highIcpCount number