API - Account Metrics (version 1)
Provides read-only access to system-wide statistics such as the number of open requests (calculated daily).
Available to users with “Boss” or “Overseer” access rights. Also available to the technical support team.
This API endpoint is tethered and may return a null result or a 503 return code.
Integrators should anticipate that all attributes may return a null value.
/api/AccountMetricV1
Element | Type | Details |
|---|---|---|
/api/accountmetricv1 | URL path | The URL path to the REST endpoints. |
/?apikey={id}&from=yyyy-mm-ddThh:mm:ss&to=yyyy-mm-ddThh:mm:ss | GET collection | Returns a JSON encoded array of AccountMetricV1 records. {from} and {to} can be optionally specified to date-constrain the results to the specified UtcDate date/time range. |
/yyyy-mm-ddThh:mm?apikey={id} | GET single detailed record | Returns a JSON encoded AccountMetricV1 record with additional details within JSON encoded attributes. |
AccountMetricV1 data structure
Attributes returned by this endpoint use a naming convention.
Prefixes:
Draft: Request that is being prepared
Open: Request that is open for responses
FytdClosed: Request that closed during the financial year (July to June)
YtdClosed: Request that closed during the calendar year (January to December)
FytdFinalised: Request that was finalised during the financial year (July to June)
YtdFinalised: Request that was finalised during the calendar year (January to December)
Time periods:
Fytd: Financial year to date (July to June)
Ytd: Calendar year to date (January to December)
0To3Days: 0 to 3 days overdue
4To7Days: 4 to 7 days overdue
8To30Days: 8 to 30 days overdue
Gt30Days: Greater than 30 days overdue
Attribute | Type | Details |
|---|---|---|
UtcDate | date/time attribute | The date and approximate time the metric was created. |
LocalDate | date/time attribute | The date and approximate time the metric was created (in the account’s time zone) |
User Counts |
|
|
UserCount | integer attribute | The number of users who can sign-in (note - they may have no access rights) |
ActiveUserCount | integer attribute | The number of users who have signed-in within 14 days prior to UtcDate |
BossUserCount | integer attribute | The number of users with the “Boss” access right Data not available in early records |
MgrUserCount | integer attribute | The number of users with the “Manager” access right excluding those with the “Boss” access right Data not available in early records |
OtherUserCount | integer attribute | The number of users with any access right other than the “Boss” and “Manager” access rights Data not available in early records |
KPI counts |
|
|
ReleaseOverdue[period]Count | integer attribute | The number of requests are overdue to be released by the specified period (see list above) |
EvaluationOverdue[period]Count | integer attribute | The number of requests are overdue to be evaluated by the specified period (see list above) |
DecisionOverdue[period]Count | integer attribute | The number of requests are overdue to be decided by the specified period (see list above) |
AgreementOverdue[period]Count | integer attribute | The number of requests are overdue to be agreements signed by the specified period (see list above) |
DebriefingOverdue[period]Count | integer attribute | The number of requests are overdue to have debriefings issued by the specified period (see list above) |
FinalisationOverdue[period]Count | integer attribute | The number of requests are overdue to be finalised by the specified period (see list above) |
Request data |
|
|
[prefix]Requests | 6 lists of RequestInfo objects | For single record downloads only! The list of Request records (see data description below) within the grouping identified by the prefix (see list above). |
[prefix]RequestCount | integer attribute | The number of requests within the grouping identified by the prefix (see list above). |
[prefix]AvgBudget | money attribute | The average budget of the requests within the grouping identified by the prefix (see list above) that have a budget specified. |
[prefix]AvgEstContractValue | money attribute | The average estimated contract value of the requests within the grouping identified by the prefix (see list above) that have an estimate specified. |
[prefix]AvgEstAdSpend | money attribute | The average estimated advertising spend of the requests within the grouping identified by the prefix (see list above) that have an estimate specified. |
[prefix]AvgEstInternalSpend | money attribute | The average estimated internal spend (staff and other internal costs) of the requests within the grouping identified by the prefix (see list above) that have an estimate specified. |
[prefix]AvgActualContractValue | money attribute | The average actual contract value of the requests within the grouping identified by the prefix (see list above) that have a value specified. |
[prefix]AvgActualAdSpend | money attribute | The average actual advertising spend of the requests within the grouping identified by the prefix (see list above) that have a value specified. |
[prefix]AvgActualInternalSpend | money attribute | The average actual internal spend (staff and other internal costs) of the requests within the grouping identified by the prefix (see list above) that have a value specified. |
[prefix]TotalBudget | money attribute | The sum-total budget of the requests within the grouping identified by the prefix (see list above) that have a budget specified. |
[prefix]TotalEstContractValue | money attribute | The sum-total estimated contract value of the requests within the grouping identified by the prefix (see list above) that have an estimate specified. |
[prefix]TotalEstAdSpend | money attribute | The sum-total estimated advertising spend of the requests within the grouping identified by the prefix (see list above) that have an estimate specified. |
[prefix]TotalEstInternalSpend | money attribute | The sum-total estimated internal spend (staff and other internal costs) of the requests within the grouping identified by the prefix (see list above) that have an estimate specified. |
[prefix]TotalActualContractValue | money attribute | The sum-total actual contract value of the requests within the grouping identified by the prefix (see list above) that have a value specified. |
[prefix]TotalActualAdSpend | money attribute | The sum-total actual advertising spend of the requests within the grouping identified by the prefix (see list above) that have a value specified. |
[prefix]TotalActualInternalSpend | money attribute | The sum-total actual internal spend (staff and other internal costs) of the requests within the grouping identified by the prefix (see list above) that have a value specified. |
[period]UnspecifiedLeadPct | percentage attribute | The percentage of participants that did not specify how they heard about the request (includes invited participants) for the period specified. |
[period]SocialMediaLeadPct | percentage attribute | The percentage of participants that specified they heard about the request via social media (e.g. Facebook, Twitter, LinkedIn, etc.) for the period specified. |
[period]TradMediaLeadPct | integer attribute | The percentage of participants that specified they heard about the request via traditional media (e.g. newspapers, radio, etc.) for the period specified. |
[period]EmailLeadPct | percentage attribute | The percentage of participants that specified they heard about the request via an email from 360 for the period specified. |
[period]PaidSvcLeadCount | percentage attribute | The number of participants that specified they heard about the request via a paid subscription service. |
[period]FreeSvcLeadPct | percentage attribute | The percentage of participants that specified they heard about the request via a free subscription service (e.g. AusTender) for the period specified. |
[period]OtherLeadPct | percentage attribute | The percentage of participants that specified they heard about the request via a method not specified above for the period specified. |
[period]NoRatingPct | percentage attribute | The percentage of respondents that did not give a rating for the questionnaire for the period specified. |
[period]Rating[n]Pct | 5 decimal attributes | The percentage of respondents that rated the question as n/5 for the period specified. n is either:
|
RequestInfo structure (included when downloading a single-record)
Attribute | Type | Details |
|---|---|---|
RequestId | integer attribute | The unique identifier of a request. |
RequestName | text attribute | The name of the request (non-unique). |
RequestDesc | html attribute | The description of the request. |
UtcOpenDate | date/time attribute | The date the request was opened (UTC). |
LocalOpenDate | date/time attribute | The date the request was opened (in the account’s time zone). |
UtcCloseDate | date/time attribute | The date the request closed/is schedule to close (UTC). |
LocalCloseDate | date/time attribute | The date the request closed/is schedule to close (in the account’s time zone). |
UtcFinalisationDate | date/time attribute | The date the request closed/is schedule to close (UTC). |
LocalFinalisationDate | date/time attribute | The date the request closed/is schedule to close (in the account’s time zone). |
Budget | money attribute | The request’s budget. |
EstContractValue | money attribute | The request’s estimated contract value. |
EstAdSpend | money attribute | The request’s estimated advertising spend. |
EstInternalSpend | money attribute | The request’s estimated internal spend (staff and other internal costs). |
ActualContractValue | money attribute | The request’s actual contract value. |
ActualAdSpend | money attribute | The request’s actual advertising spend. |
ActualInternalSpend | money attribute | The request’s actual internal spend (staff and other internal costs). |
EstParticipantCount | integer attribute | The estimated number of participants. |
ActualParticipantCount | integer attribute | The number of providers that have registered to participate in the request. |
EstRespondentCount | integer attribute | The estimated number of respondents. |
ActualRespondentCount | integer attribute | The actual number of participants that have submitted their responses. |
UnspecifiedLeadCount | integer attribute | The number of participants that did not specify how they heard about the request (includes invited participants). |
SocialMediaLeadCount | integer attribute | The number of participants that specified they heard about the request via social media (e.g. Facebook, Twitter, LinkedIn, etc.). |
TradMediaLeadCount | integer attribute | The number of participants that specified they heard about the request via traditional media (e.g. newspapers, radio, etc.). |
EmailLeadCount | integer attribute | The number of participants that specified they heard about the request via an email from 360. |
PaidSvcLeadCount | integer attribute | The number of participants that specified they heard about the request via a paid subscription service. |
FreeSvcLeadCount | integer attribute | The number of participants that specified they heard about the request via a free subscription service (e.g. AusTender). |
OtherLeadCount | integer attribute | The number of participants that specified they heard about the request via a method not specified above. |
NoRatingCount | integer attribute | The number of respondents that did not give a rating for the questionnaire. |
Rating[n]Count | 5 integer attributes | The number of respondents that rated the question as n/5. n is either:
|
Related articles
https://simplylogical.atlassian.net/wiki/spaces/CS/pages/2129723393
https://simplylogical.atlassian.net/wiki/spaces/CS/pages/2204958721
Terms of use
Visitors who are not part of the intended audience (as specified on this space's overview page) may not access this content.
If you are accessing content for which you are not the intended audience you may not use it for any purpose.
As private content can be published in error, if in doubt, you are not the intended audience.
Copyright © - Sharrowlane Pty Ltd