Jump to

• Request
• Response

Get a candidate role user attributes analytics for the given user attributes

post

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/user-attribute-analytics

Request

Path Parameters

• candidateRoleId: string
• taskId: string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• topCount(optional): integer
• userAttributeNames(optional): array userAttributeNames

{
    "properties":{
        "topCount":{
            "type":"integer"
        },
        "userAttributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : userAttributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CandidateRoleUserAttributeAnalyticsResponse

Type: object

Show Source

• analyticResults(optional): array analyticResults
• topCount(optional): integer

{
    "properties":{
        "topCount":{
            "type":"integer"
        },
        "analyticResults":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnalyticResults"
            }
        }
    }
}

Nested Schema : analyticResults

Type: array

Show Source

• Array of: object AnalyticResults

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AnalyticResults"
    }
}

Nested Schema : AnalyticResults

Type: object

Show Source

• results(optional): array results
• totalCount(optional): integer
• userAttributeName(optional): string

{
    "properties":{
        "userAttributeName":{
            "type":"string"
        },
        "totalCount":{
            "type":"integer"
        },
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnalyticResult"
            }
        }
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object AnalyticResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AnalyticResult"
    }
}

Nested Schema : AnalyticResult

Type: object

Show Source

• displayName(optional): string
• percentage(optional): integer

{
    "properties":{
        "displayName":{
            "type":"string"
        },
        "percentage":{
            "type":"integer"
        }
    }
}

Back to Top