Skip to content
Prokure Docs

Get dashboard summary

GET
/api/v1/dashboard
curl --request GET \
  --url 'https://app.prokure.ca/api/v1/dashboard?range=7d'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
range
string
default: 30d
Allowed values: 7d 30d 90d

Length of the reporting period, in tenant-local calendar days ending today.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
range
required
string
Allowed values: 7d 30d 90d
timezone
required

IANA time zone the account’s digest runs in; every day boundary below is a boundary in it.

string
generated_at
required

Instant the numbers were computed.

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
window
required
object
current_from
required

Tenant-local calendar date, YYYY-MM-DD, inclusive.

string
current_to
required

Tenant-local calendar date, YYYY-MM-DD, inclusive.

string
previous_from
required

Tenant-local calendar date, YYYY-MM-DD, inclusive.

string
previous_to
required

Tenant-local calendar date, YYYY-MM-DD, inclusive.

string
stats
required
object
scanned
required

Solicitations Prok evaluated for this account, counted on the day the notice was discovered.

object
current
required

Count over the current window.

integer
>= -9007199254740991 <= 9007199254740991
previous
required

Count over the window of equal length immediately before it.

integer
>= -9007199254740991 <= 9007199254740991
surfaced
required

Distinct solicitations that reached the account in a digest email.

object
current
required

Count over the current window.

integer
>= -9007199254740991 <= 9007199254740991
previous
required

Count over the window of equal length immediately before it.

integer
>= -9007199254740991 <= 9007199254740991
digests_sent
required

Digest emails sent to the account.

object
current
required

Count over the current window.

integer
>= -9007199254740991 <= 9007199254740991
previous
required

Count over the window of equal length immediately before it.

integer
>= -9007199254740991 <= 9007199254740991
positive_feedback
required

Feedback events recording interest in a solicitation.

object
current
required

Count over the current window.

integer
>= -9007199254740991 <= 9007199254740991
previous
required

Count over the window of equal length immediately before it.

integer
>= -9007199254740991 <= 9007199254740991
negative_feedback
required

Feedback events rejecting a solicitation.

object
current
required

Count over the current window.

integer
>= -9007199254740991 <= 9007199254740991
previous
required

Count over the window of equal length immediately before it.

integer
>= -9007199254740991 <= 9007199254740991
open_now
required

Solicitations surfaced and still open right now. Point-in-time, not windowed.

integer
>= -9007199254740991 <= 9007199254740991
queued_for_digest
required

Solicitations waiting for the next digest and still open. Point-in-time, not windowed.

integer
>= -9007199254740991 <= 9007199254740991
series
required

One row per day of the current window, ascending, zero-filled on days with no activity.

Array<object>
object
day
required

Tenant-local calendar date, YYYY-MM-DD, inclusive.

string
scanned
required
integer
>= -9007199254740991 <= 9007199254740991
surfaced
required
integer
>= -9007199254740991 <= 9007199254740991
setup
required
object
profile
required
object
complete
required
boolean
missing_fields
required

Company-profile fields Prok reads when scoring that are still unset.

Array<string>
products
required
object
active
required
integer
>= -9007199254740991 <= 9007199254740991
partners
required

Authorized manufacturer partners.

integer
>= -9007199254740991 <= 9007199254740991
context_docs
required
object
ready
required

Context documents ingested and searchable.

integer
>= -9007199254740991 <= 9007199254740991
notification_recipients
required
object
configured
required
boolean
feedback
required
object
total
required

Feedback events recorded for the account, all time.

integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "range": "7d"
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}