Reports and analytics

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/activity/health' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/activity/timeline' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "stream": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/attribution' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "model": "str",
    "deals_considered": "int",
    "deals_attributed": "int",
    "channels": [
      "<empty list>"
    ]
  }
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/analytics/attribution/backfill' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "…",
  "touches_created": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/campaign-performance' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/contract-cycle' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/email' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "totals": {
      "sent": "int",
      "opened": "int",
      "clicked": "int",
      "replied": "int",
      "bounced": "int",
      "failed": "int",
      "unsubscribed": "int"
    },
    "rates": {
      "open_rate": "float",
      "click_rate": "float",
      "reply_rate": "float",
      "bounce_rate": "float"
    },
    "per_sequence": [
      {
        "sequence": "...",
        "sent": "...",
        "opened": "...",
        "replied": "..."
      },
      "...x4"
    ]
  }
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/engagement' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/funnel' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/overview' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "days": "int",
    "contacts": {
      "total": "int",
      "new_30d": "int"
    },
    "companies": {
      "total": "int"
    },
    "deals": {
      "open_count": "int",
      "open_value": "float",
      "won_value_30d": "float",
      "stages": [
        "...",
        "...x6"
      ]
    },
    "emails": {
      "sent_30d": "int",
      "opened_30d": "int",
      "replied_30d": "int",
      "open_rate": "float",
      "reply_rate": "float"
    },
    "sequences": {
      "active": "int",
      "enrolled": "int"
    },
    "campaigns": {
      "total": "int",
      "sending": "int",
      "done": "int",
      "last": {
        "id": "...",
        "name": "...",
        "status": "...",
        "sent": "...",
        "opened": "..."
      }
    },
    "meetings": {
      "upcoming_7d": "int"
    },
    "contracts": {
      "draft": "int",
      "sent": "int",
      "partially_signed": "int",
      "completed": "int",
      "voided": "int"
    },
    "opportunities": {
      "open": "int",
      "applications": "int"
    },
    "mailboxes": {
      "count": "int"
    },
    "unread_notifications": "int",
    "recent_activity": [
      {
        "title": "...",
        "message": "...",
        "created_at": "...",
        "data": "..."
      },
      "...x10"
    ]
  }
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/pipeline-history' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "date": "str",
      "stage": "str",
      "deal_count": "int",
      "amount_cents": "int",
      "weighted_cents": "int"
    },
    "...x9"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/analytics/pipeline-snapshot/run' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "rows_written": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/sales' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "win_rate": "float",
    "deals": {
      "open": "int",
      "won": "int",
      "lost": "int"
    },
    "won_value": "float",
    "avg_deal_size": "float",
    "per_stage": [
      {
        "stage": "...",
        "color": "...",
        "count": "...",
        "value": "..."
      },
      "...x6"
    ],
    "velocity": [
      {
        "stage": "...",
        "avg_hours": "...",
        "transitions": "..."
      },
      "...x1"
    ],
    "contacts_monthly": [
      {
        "month": "...",
        "count": "..."
      },
      "...x1"
    ]
  }
}

curl 'https://api.vxcloud.io/api/v1/salesshift/analytics/timeseries' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/dashboards' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "name": "str",
      "description": "null",
      "is_default": "bool",
      "visibility": "str"
    },
    "...x1"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/dashboards' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "name": "<string>", "description": "<string>", "is_default": false }'

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/dashboards/{dashboard_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/dashboards/{dashboard_id}/widgets' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "report_id": "<string(uuid)>", "title_override": "<string>", "x": 0, "y": 0, "w": 6, "h": 4 }'

{
  "data": "…",
  "success": "…"
}

curl -X DELETE 'https://api.vxcloud.io/api/v1/salesshift/dashboards/widgets/{widget_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "deleted": "…",
  "success": "…"
}

curl -X PATCH 'https://api.vxcloud.io/api/v1/salesshift/deals/{deal_id}/forecast-category' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "forecast_category": "<value>" }'

{
  "forecast_category": "…",
  "success": "…"
}

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "to_email": "str",
      "from_email": "str",
      "contact_id": "str",
      "contact_name": "str",
      "subject": "str",
      "status": "str",
      "provider": "str",
      "open_count": "int",
      "click_count": "int",
      "error": "str",
      "body_html": "str",
      "reply_body": "null",
      "reply_category": "null",
      "sent_at": "null",
      "first_opened_at": "null",
      "replied_at": "null",
      "created_at": "str"
    },
    "...x2"
  ]
}

curl 'https://api.vxcloud.io/api/v1/salesshift/forecast' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "period_start": "str",
    "period_end": "str",
    "categories": {
      "best_case": {
        "deal_count": "...",
        "amount_cents": "..."
      },
      "commit": {
        "deal_count": "...",
        "amount_cents": "..."
      },
      "pipeline": {
        "deal_count": "...",
        "amount_cents": "..."
      }
    },
    "closed_won_cents": "int",
    "submissions": [
      {
        "id": "...",
        "user_id": "...",
        "commit_cents": "...",
        "best_case_cents": "...",
        "pipeline_cents": "...",
        "note": "...",
        "submitted_at": "..."
      },
      "...x1"
    ]
  }
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/forecast/submit' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "best_case_cents": "<value>", "commit_cents": "<value>", "currency": "<value>", "note": "<value>", "period_end": "<value>", "period_start": "<value>", "pipeline_cents": "<value>" }'

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/goals' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "subject_type": "str",
      "subject_id": "str",
      "metric": "str",
      "period": "str",
      "period_start": "str",
      "period_end": "str",
      "target_value": "int",
      "currency": "null"
    },
    "...x1"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/goals' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "currency": "<value>", "metric": "<value>", "period": "<value>", "period_end": "<value>", "period_start": "<value>", "subject_id": "<value>", "subject_type": "<value>", "target_value": "<value>" }'

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/goals/leaderboard' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/reports' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "id": "str",
      "name": "str",
      "description": "null",
      "dataset": "str",
      "config": {
        "measures": "...",
        "dimensions": "..."
      },
      "owner_id": "int",
      "visibility": "str",
      "created_at": "str",
      "updated_at": "str"
    },
    "...x1"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/reports' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Contacts by lifecycle stage", "dataset": "contacts", "config": { "dimensions": [ { "field": "contact.lifecycle_stage" } ], "measures": [ { "field": "contact.id", "agg": "count" } ] } }'

{
  "success": "bool",
  "data": {
    "id": "str",
    "name": "str",
    "dataset": "str",
    "config": {
      "dimensions": "...",
      "measures": "..."
    }
  }
}

curl 'https://api.vxcloud.io/api/v1/salesshift/reports/{report_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": {
    "id": "str",
    "name": "str",
    "description": "null",
    "dataset": "str",
    "config": {
      "measures": [
        "...",
        "...x1"
      ],
      "dimensions": [
        "...",
        "...x1"
      ]
    },
    "owner_id": "int",
    "visibility": "str",
    "created_at": "str",
    "updated_at": "str",
    "result": {
      "dataset": "str",
      "columns": [
        "...",
        "...x2"
      ],
      "rows": [
        "...",
        "...x6"
      ],
      "row_count": "int",
      "truncated": "bool"
    }
  }
}

curl -X PATCH 'https://api.vxcloud.io/api/v1/salesshift/reports/{report_id}' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "config": "<value>", "dataset": "<value>" }'

{
  "data": "…",
  "success": "…"
}

curl -X DELETE 'https://api.vxcloud.io/api/v1/salesshift/reports/{report_id}' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "deleted": "bool"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/reports/{report_id}/export' \
  -H "Authorization: Bearer $SS_TOKEN"

"CSV text: a header row of column labels, then one row per group."

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/reports/{report_id}/schedule' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "frequency": "weekly", "hour_utc": 7, "weekday": 0, "day_of_month": 0, "recipients": "", "format": "csv", "is_active": true }'

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/reports/{report_id}/schedules' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "data": "…",
  "success": "…"
}

curl 'https://api.vxcloud.io/api/v1/salesshift/reports/datasets' \
  -H "Authorization: Bearer $SS_TOKEN"

{
  "success": "bool",
  "data": [
    {
      "key": "str",
      "label": "str",
      "description": "str",
      "default_date_field": "str",
      "fields": [
        "...",
        "...x16"
      ]
    },
    "...x10"
  ]
}

curl -X POST 'https://api.vxcloud.io/api/v1/salesshift/reports/run' \
  -H "Authorization: Bearer $SS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "dataset": "contacts", "config": { "metrics": [ { "agg": "count" } ] } }'

{
  "detail": "str"
}