Segmentation

Segmentation metadata related operations

Retrieves all the areas metadata and configuration available for your company in a hirarchical way

get

The information provided by this endpoint is useful to build the filters on the stats API or setup the employee profiles on the Employees API.

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Responses

200

OK

*/*

get

/v1/public/company/hierarchy

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "id": "64f8a0e2d5b7c9a1e3f4a5b6",
    "name": "text",
    "children": []
  }
]

Retrieves all the group metadata (eg: perfomant users, newbies...) and configuration available for your company

get

The information provided by this endpoint is useful to build the filters on the stats API or setup the employee profiles on the Employees API.

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Responses

200

OK

*/*

get

/v1/public/company/groups

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "id": "64f8a0e2d5b7c9a1e3f4a5b6",
    "name": "text"
  }
]

Retrieves all the personal profile metadata (eg: gender, age, tenure) and configuration available for your company

get

The information provided by this endpoint is useful to build the filters on the stats API or setup the employee profiles on the Employees API.

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Responses

200

OK

*/*

get

/v1/public/company/characteristics

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "id": "64f8a0e2d5b7c9a1e3f4a5b6",
    "type": "DATE",
    "name": "text",
    "allowedValues": [
      {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "label": "text"
      }
    ]
  }
]