Performance Enhancements to Search APIs

Performance Enhancements to Search APIs

We recently detected a few performance issues that were caused by the inclusion of inessential information in responses to search APIs. In particular, ticket search APIs returned not only the custom fields in a ticket, but also the ones related to the contact in the ticket. Similarly, contact search APIs returned not only the custom fields related to a contact, but also the ones related to the account associated. This inclusion of non-vital information led to performance issues in tools that employed these APIs. Therefore, to solve the performance issues and to ensure that only the most relevant details are returned, we have tweaked the APIs to return only vital information.

Below are some examples of responses that will be returned for these APIs, going forward.

Search tickets: /api/v1/tickets/search

{

"data" : [ {
"ticketNumber" : "101",
"modifiedTime" : "2016-06-21T12:58:09.122Z",
"subCategory" : "Sub General",
"subject" : "Real Time analysis Requirement",
"customFields" : {
},
"dueDate" : "2016-06-23T12:58:09.211Z",
"departmentId" : "1892000000006907",
"channel" : "Email",
"description" : "Hai This is description",
"resolution" : null,
"closedTime" : null,
"isOverDue" : true,
"responseDueDate" : null,
"contact" : {
"firstName" : "Jonathan",
"lastName" : "Casie",
"accountId" : "1892000000045028",
"id" : "5000000009587",
"email" : "casie@zylker.com",
"account" : {
"accountName" : "Zylker Account",
"id" : "1892000000980421"
}
},
"createdTime" : "2016-06-21T12:50:04.000Z",
"modifiedBy" : "1892000000056007",
"id" : "1892000001054003",
"department" : {
"name" : "Testing",
"id" : "5000000007235"
},
"email" : " carol@zylker.com ",
"customerResponseTime" : "2016-11-02T10:38:07.000Z",
"productId" : null,
"contactId" : "1892000000042032",
"threadCount" : "0",
"lastThread" : null,
"priority" : "High",
"classification" : null,
"assigneeId" : "1892000000056007",
"commentCount" : "0",
"accountId" : null,
"phone" : null,
"assignee" : {
"firstName" : "",
"lastName" : "jade",
"emailId" : " jade@zylker.com ",
"id" : "5000000009116",
"zuid" : "10657727"
},
"category" : "General",
"status" : "Open"
} ],
"count" : 1
}

Search contacts: /api/v1/contacts/search


"data" : [ {
"zip" : null,
"lastName" : "Lawrence",
"country" : null,
"modifiedTime" : "2016-05-04T09:57:17.000Z",
"secondaryEmail" : null,
"city" : null,
"customFields" : {



  "permanentAddress" : null,
      "lastContactedOn" : null
},
"facebook" : null,
"mobile" : null,
"description" : null,
"title" : null,
"type" : null,
"ownerId" : "1892000000042001",
"firstName" : null,
"accountId" : "1892000000975382",
"twitter" : null,
"phone" : "1 888 900 9646",
"street" : null,
"createdTime" : "2013-11-04T11:21:07.000Z",
"state" : null,
"id" : "1892000000042032",
"email" : "support@zohodesk.com",
"account" : {
"accountName" : "Zylker",
"id" : "1892000000975382"
}
} ],
"count" : 1
}


We request you to update your tools within  three weeks to accommodate this change.

    Access your files securely from anywhere

        Zoho Developer Community




                                  Zoho Desk Resources

                                  • Desk Community Learning Series


                                  • Digest


                                  • Functions


                                  • Meetups


                                  • Kbase


                                  • Resources


                                  • Glossary


                                  • Desk Marketplace


                                  • MVP Corner


                                  • Word of the Day



                                      Zoho Marketing Automation


                                              Manage your brands on social media



                                                    Zoho TeamInbox Resources

                                                      Zoho DataPrep Resources



                                                        Zoho CRM Plus Resources

                                                          Zoho Books Resources


                                                            Zoho Subscriptions Resources

                                                              Zoho Projects Resources


                                                                Zoho Sprints Resources


                                                                  Qntrl Resources


                                                                    Zoho Creator Resources



                                                                        Zoho Campaigns Resources


                                                                          Zoho CRM Resources

                                                                          • CRM Community Learning Series

                                                                            CRM Community Learning Series


                                                                          • Kaizen

                                                                            Kaizen

                                                                          • Functions

                                                                            Functions

                                                                          • Meetups

                                                                            Meetups

                                                                          • Kbase

                                                                            Kbase

                                                                          • Resources

                                                                            Resources

                                                                          • Digest

                                                                            Digest

                                                                          • CRM Marketplace

                                                                            CRM Marketplace

                                                                          • MVP Corner

                                                                            MVP Corner





                                                                              Design. Discuss. Deliver.

                                                                              Create visually engaging stories with Zoho Show.

                                                                              Get Started Now