Warning! These features are no longer available for customers who signed up after July 27th, 2022.
Tymeshift API
Zendesk account name (user), Your tymeshift token (token) and Account creator email (requester_email) is required parameters and must be included to every api request.
You can find this info at settings page of your tymeshift account: ADMIN -> SETTINGS -> SHOW ADVANCED OPTIONS You see "API TOKEN" and "ACCOUNT CREATOR EMAIL"
Payroll period start selector. Can be one of the following values: 0 - not using (in this case used start_time and end_time properties) 1 - current payroll period 2 - previous payroll period 3 - 2 weeks ago payroll period 4 - 3 weeks ago payroll period -1 - last 7 days -2 - last 14 days -3 - last 21 days -4 - last 28 days
start_time
false
integer
Start time (unix format). Not used if payroll_period_start != 0
end_time
false
integer
Start time (unix format). Not used if payroll_period_start != 0
The above command returns JSON structured like this:
{start_time:1529107200,end_time:1529712000,result_total:{status:"ok",start_time:"2018-06-16T00:00:00+00:00",end_time:"2018-06-23T00:00:00+00:00",data:{totals:{job_codes:[{zend_ticket_id:"287795486",total:"151",ticket_name:"74 - Lara Colon",nice_id:"74"},{zend_ticket_id:"287797686",total:"58",ticket_name:"258 - Greta Hardin",nice_id:"258"}],users:[{zend_user_id:"68192186",total:"1261",username:"Emily Costa",email:"elisa@tymeshift.com"}]}}}}
Generate basic report
HTTP Request
GET /api/basicreport
Query Parameters
Parameter
Required
Type
Description
user
true
string
Zendesk account name
token
true
string
Your tymeshift token
requester_email
true
string
Account creator email
agent_id
false
integer
Tymeshift user ID
group_id
false
integer
Zendesk group ID
payroll_period_start
false
integer
Payroll period start selector. Can be one of the following values: - not using (in this case used start_time and end_time properties) - current payroll period - previous payroll period - 2 weeks ago payroll period - 3 weeks ago payroll period - last 7 days - last 14 days - last 21 days - last 28 days
start_time
false
integer
Start time (unix format). Not used if payroll_period_start != 0
end_time
false
integer
End time (unix format). Not used if payroll_period_start != 0
ticket_status
false
integer
Ticket Status can be one of the following values: - any status\n1 - new - open - pending - solved - closed - hold\n
tags_all
false
string
String separated by comma with tags what EACH present at the ticket (if one of this tags not present at the ticket then the ticket is NOT relevant)
tags_any
false
string
String separated by comma with tags what ANY present at the ticket (if one of this tags is present at the ticket then the ticket IS relevant)
tags_none
false
string
String separated by comma with tags what NOT present at the ticket (if one of this tags IS present at the ticket then the ticket is NOT relevant)
The above command returns JSON structured like this:
{"status":"ok","data":[{"startTime":"1558640468","pointType":"solved","agentId":"57052215","agentName":"Will Smith","groupId":"360000171443","groupName":"Dream Team","ticketId":"506595935","ticketNiceId":"1366","ticketName":"1366 - Will Smith"},{"startTime":"1565161557","pointType":"solved","agentId":"57054555","agentName":"John Doe","groupId":"20795777","groupName":"Support","ticketId":"506599805","ticketNiceId":"1681","ticketName":"1681 - John Doe"},{"startTime":"1565161538","pointType":"solved","agentId":"57054555","agentName":"John Doe","groupId":"20795777","groupName":"Support","ticketId":"506599765","ticketNiceId":"1679","ticketName":"1679 - John Doe"},],"total":{"data":{"c193f59b25495d4ee47166326ef372c83842cb4e":{"event_sum":152523415,"event_num":156,"event_num2":156,"sum":156,"type_id":"32","type":"solved","day":"2019-05-06","event_sum2":0},"6fb6fcb5fde5322771cc5991ab894b1bac8c08a3":{"event_sum":44363692.833333,"event_num":18,"event_num2":18,"sum":21,"type_id":"37","type":"reopened","day":"2019-05-24","event_sum2":0}},"total":177},"start":1556686800,"end":1565845199,"tz":-5,"timezone":"US/Central","lastDay":"05/01/2019"}
Get information about solved/escalated/attended/reopened points.
HTTP Request
GET /api/GetSpecificMetrics
Query Parameters
Parameter
Required
Type
Description
token
true
string
Your tymeshift token
ticket_types
true
array
Set of these possible values: ["solved", "escalated", "attended", "reopened"]. Must include at least one value.
start_date
true
string
Start date (MM/DD/YYYY).
end_date
true
string
End date (MM/DD/YYYY).
reporting_period
false
string
Points to the type of reporting period. Can be one of the following values: ['today', 'yesterday', 'custom']
offset
false
integer
It's used for ability to select data from required result line's number. It will be >= 0. By default = 0
limit
false
integer
It's used for setting the limit to returned information. It will be >= 0. By default = 100
last_id
false
integer
It's used for retrieving information starting from exact ID value in 'EventsSe' model. It will be >= 0. By default = 0
agents
false
array
Contains agents' IDs. Results will be calculated only for agents with these IDs.
group_id
false
integer
Information will be returned only by those agents which are belong to specified group. This option has higer priority than 'agents' parameter.
order
false
string
Can be used for sorting results by different values. Allowed values: 10: Order by t.id ASC. 9: Order by t.ID DESC. 'username.asc': Order by t.zend_user_id ASC, t.id DESC. 'username.desc': Order by t.zend_user_id DESC, t.id DESC. 'jobname.asc': Order by zend_ticket.tsheet_job_name ASC, t.id DESC. 'jobname.desc': Order by zend_ticket.tsheet_job_name DESC, t.id DESC. 'metric.asc': Order by t.se_type ASC, t.id DESC. 'metric.desc': Order by t.se_type DESC, t.id DESC. Default grouping is by t.start_time DESC, t.id DESC.
Generate report with metrics for requested time period.
HTTP Request
GET /api/listMetrics
Query Parameters
Parameter
Required
Type
Description
user
true
string
Zendesk account name
token
true
string
Your tymeshift token
requester_email
true
string
Account creator email
start_time
false
integer
Start time (MM/DD/YYYY).
end_time
false
integer
End time (MM/DD/YYYY).
prim_groupby
false
integer
Grouping Level 1 can be one of the following values: 0 - Customer (default), 2 - Agent, 3 - Group, 4 - Day, 5 - Ticket Field, 10 - Ticket Time Category.
sub_groupby
false
integer
Grouping Level 2 can be one of the following values: 0 - Ticket ID, 3 - Agent, 4 - Group, 5 - Day, 6 - Ticket Field, 11 - Ticket Time Category. By default it group by Ticket ID.
sub_sub_groupby
false
integer
Grouping Level 3 can be one of the following values: 3 - Agent, 4 - Group, 5 - Day, 6 - Ticket Field, 11 - Ticket Time Category.
Generate report with metrics for the selected time period.
HTTP Request
GET /api/getMetrics
Query Parameters
Parameter
Required
Type
Description
user
true
string
Zendesk account name
token
true
string
Your tymeshift token
requester_email
true
string
Account creator email
start_time
false
integer
Start time (MM/DD/YYYY).
end_time
false
integer
End time (MM/DD/YYYY).
prim_groupby
false
integer
Grouping Level 1 can be one of the following values: 0 - Customer (default), 2 - Agent, 3 - Group, 4 - Day, 5 - Ticket Field, 10 - Ticket Time Category.
sub_groupby
false
integer
Grouping Level 2 can be one of the following values: 0 - Ticket ID, 3 - Agent, 4 - Group, 5 - Day, 6 - Ticket Field, 11 - Ticket Time Category. By default it group by Ticket ID.
sub_sub_groupby
false
integer
Grouping Level 3 can be one of the following values: 3 - Agent, 4 - Group, 5 - Day, 6 - Ticket Field, 11 - Ticket Time Category.