Get how far the ranking is

GET

/api/postings/ranking

curl --request GET \
  --url http://127.0.0.1:8765/api/postings/ranking

How far the ranking is: the ranking block and the rank job, two counts a profile. 0.1.11.3: what the Jobs page polls while a rank runs (a background rank, a Rank now, a Re-rank). ranking is the block of GET /api/postings (in_progress, by_profile ranked of total in the window); job the rank job this server runs, or null. It reads two counts a profile: it refreshes nothing, reads no posting row and writes nothing, so it costs the same on a small and on a very large home.

Responses

200

Success.

Media typeapplication/json

object

schema_version

required

Allowed value: scout-postings-ranking:1

key

additional properties

any

Example

{
  "job": null,
  "ranking": {
    "by_profile": [
      {
        "profile_id": "prof_1",
        "ranked": 509,
        "stale_resume": false,
        "total": 792
      }
    ],
    "enabled": true,
    "in_progress": true,
    "stale_resume": false,
    "window_days": 7
  },
  "schema_version": "scout-postings-ranking:1"
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

404

Target_unavailable

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "target_unavailable",
    "message": "..."
  }
}

422

Unknown_key

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "unknown_key",
    "message": "..."
  }
}