Stats

Stats related operations

Retrieves the Stats of a score for a given iteractions

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Path parameters

scoreIdstringRequired

Score from which the stats should be retrieved

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Query parameters

fromstring · date-timeOptional

For which date from the results should be returned

tostring · date-timeOptional

For which date to the results should be returned

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied. Check examples for details

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

/v1/public/company/stats/scores/stats/{scoreId}

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/scores/stats/{scoreId} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "from": "2025-12-23T23:55:00.400Z",
  "to": "2025-12-23T23:55:00.400Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-12-23T23:55:00.400Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "factors": [
        {
          "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA",
          "questions": [
            {
              "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
              "result": 1,
              "participants": 1,
              "distribution": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "quality": "NO_DATA",
              "valuation": "NO_DATA"
            }
          ]
        }
      ],
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "distribution": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "factors": [
    {
      "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "result": 1,
      "participants": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "quality": "NO_DATA",
      "valuation": "NO_DATA",
      "questions": [
        {
          "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA"
        }
      ]
    }
  ],
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}

Retrieves the Stats of a score for a given iteractions

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Path parameters

scoreIdstringRequired

Score from which the stats should be retrieved

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Query parameters

fromstring · date-timeOptional

For which date from the results should be returned

tostring · date-timeOptional

For which date to the results should be returned

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied. Check examples for details

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

/v1/public/company/stats/scores/{scoreId}

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/scores/{scoreId} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "from": "2025-12-23T23:55:00.400Z",
  "to": "2025-12-23T23:55:00.400Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-12-23T23:55:00.400Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "factors": [
        {
          "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA",
          "questions": [
            {
              "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
              "result": 1,
              "participants": 1,
              "distribution": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "quality": "NO_DATA",
              "valuation": "NO_DATA"
            }
          ]
        }
      ],
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "distribution": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "factors": [
    {
      "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "result": 1,
      "participants": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "quality": "NO_DATA",
      "valuation": "NO_DATA",
      "questions": [
        {
          "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA"
        }
      ]
    }
  ],
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}

get

Retrieves the Participation stats for the requested period

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied.

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Example: 64f8a0e2d5b7c9a1e3f4a5b6

groupingstring · enumOptional

Types of date grouping intervals

Default: MONTHPossible values:

Responses

200

OK

*/*

get

/v1/public/company/stats/participation

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/participation HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": "2025-12-23T23:55:00.400Z",
  "to": "2025-12-23T23:55:00.400Z",
  "participants": 1,
  "valuation": "NO_DATA",
  "newParticipants": 1,
  "lostParticipants": 1,
  "dateResults": [
    {
      "date": "2025-12-23T23:55:00.400Z",
      "participants": 1
    }
  ]
}

Retrieves the HI stats for the requested period

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied.

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

/v1/public/company/stats/hi

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/hi HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "title": "text",
  "values": [
    {
      "id": 1,
      "score": 1,
      "label": {
        "defaultValue": "text",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "imageUrl": "text",
      "color": "text"
    }
  ],
  "ratings": "{'1': x, '2' : y}",
  "participants": 1,
  "expectedParticipants": 1,
  "periodIndex": 1,
  "dateResults": [
    {
      "date": "2025-12-23T23:55:00.400Z",
      "index": 1,
      "participants": 1
    }
  ]
}

get

Retrieves the eNPS stats for the requested period

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied.

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

/v1/public/company/stats/enps

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/enps HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": "2025-12-23T23:55:00.400Z",
  "to": "2025-12-23T23:55:00.400Z",
  "result": 1,
  "averageResult": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-12-23T23:55:00.400Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "averageResult": 1,
      "dectractors": 1,
      "neutral": 1,
      "promoters": 1,
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "dectractors": 1,
  "neutral": 1,
  "promoters": 1,
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}

get

Retrieves the Activation stats for the requested period

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied.

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

/v1/public/company/stats/activation

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/activation HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": "2025-12-23T23:55:00.400Z",
  "to": "2025-12-23T23:55:00.400Z",
  "totalInvited": 1,
  "totalActivated": 1,
  "valuation": "NO_DATA",
  "dateResults": [
    {
      "date": "2025-12-23T23:55:00.400Z",
      "invited": 1,
      "invitedAccumulated": 1,
      "activated": 1,
      "activatedAccumulated": 1
    }
  ]
}