analytics

Access high-level statistics, including detailed insights into prospects and emails, for a specific sequence.

post/v1/analytics/stats

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/analytics/stats/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

sequenceIdstring required

Id of the sequence

Example request

{
  "sequenceId": "2dP27N0gZ4"
}

Response

Sequence consolidated reports fetched successfully

unknown required

Example response

{
  "message": "Sequence consolidated fetched successfully",
  "payload": {
    "prospects": [
      {
        "total": "25",
        "open": "0",
        "replied": "0",
        "clicked": "0",
        "unsubscribed": "0",
        "contacted": "0",
        "notContacted": "25",
        "uncategorized": "0",
        "interested": "0",
        "notInterested": "0",
        "meetingBooked": "0",
        "outOfOffice": "0",
        "closed": "0",
        "notNow": "0",
        "doNotContact": "0",
        "interestedDealValue": "0",
        "meetingBookedDealValue": "0",
        "closedDealValue": "0",
        "sentNoOpen": "0",
        "openedNoReply": "0",
        "openedNoClicked": "0",
        "clickedNoReply": "0"
      }
    ],
    "emails": {
      "total": 0,
      "status": {
        "scheduled": 0,
        "delivered": 0,
        "opened": 0,
        "clicked": 0,
        "replied": 0,
        "bounced": 0,
        "failed": 0
      }
    },
    "sequenceId": "8Jwomvq5aO",
    "sequenceName": "Welcome Campaign",
    "client": {
      "id": "g9bzZq4aMd",
      "firstName": "john",
      "lastName": "doe",
      "email": "johndoe+5@saleshandy.com",
      "status": "active",
      "companyName": "Demo"
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.