{"id":1937,"date":"2014-12-15T13:06:27","date_gmt":"2014-12-15T13:06:27","guid":{"rendered":"http:\/\/evolphin.com\/help\/?p=1937"},"modified":"2020-05-18T11:15:26","modified_gmt":"2020-05-18T15:15:26","slug":"keyword-management-web-api","status":"publish","type":"post","link":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/","title":{"rendered":"Keyword Management Web API"},"content":{"rendered":"\n
Keyword Stock API<\/h2>\n\n\n\n
Keywords<\/span> are critical metadata and Zoom offers some special Web APIs targeted towards keywords management.<\/p>\n\n\n\n
The “data” parameter of the request is in JSON format. It must carry, apart from the command name i.e. cmd: getkwstock, a JSON object “message”, which will be interpreted by the Zoom API engine, to retrieve the stock. This message consists of an optional component, as given below:<\/p>\n\n\n\n
\n
data=<\/p>\n
{<\/p>\n
clientVersion:”ZoomClient\/4.1-b5835″,<\/p>\n
cmd:getkwstock,<\/p>\n
message:<\/p>\n
{<\/p>\n
mtime: <Epoch time in milliseconds from when you want to fetch the changes in the Zoom keyword database; set to 0 if you want to fetch the entire stock><\/p>\n
}<\/p>\n
}<\/p>\n<\/div>\n\n\n\n
Request Sample:<\/strong><\/p>\n\n\n\n
\n
zm_username=some_user&<\/p>\n
zm_cookie=zoom-auth-cookie-for-user&<\/p>\n
data=<\/p>\n
{<\/p>\n
clientVersion:”ZoomClient\/4.1-b5835″,<\/p>\n
cmd:getkwstock,<\/p>\n
message:<\/p>\n
{<\/p>\n
mtime: 0<\/p>\n
}<\/p>\n
}<\/p>\n<\/div>\n\n\n\n
Response JSON Syntax: <\/strong><\/p>\n\n\n\n
If successful, all entries that were either modified or added to the keyword stock<\/span> since the specified “mtime” will be returned in the form of JSON, along with the total count of keywords available. Each keyword entry contains the following:<\/p>\n\n\n\n
\n
parentKwid: <Keyword ID of the parent under which this keyword is defined; -1 if defined at the ROOT><\/p>\n
kwid: <Keyword ID of the current entry><\/p>\n
value: <String associated with the current entry><\/p>\n<\/div>\n\n\n\n
The “data” parameter of the request is in JSON format. It must carry, apart from the command name i.e. cmd: editkwstock, a JSON object called “message”, which will be interpreted by the Zoom API engine. This message consists of the following two components required to execute the editing of the stock.<\/p>\n\n\n\n
\n
newData:<\/p>\n
[<\/p>\n
{<\/p>\n
kwid: <A negative number < -1 if you want to create a new keyword, or the keyword ID of the entry that you want to edit><\/p>\n
parentKwid: <The keyword ID of the parent under which this keyword is to be created \/ moved to; specify -1 for ROOT>,<\/p>\n
value: <The keyword string><\/p>\n
}<\/p>\n
]<\/p>\n<\/div>\n\n\n\n
\n
delData:<\/p>\n
[<\/p>\n
< specify the list of comma-separated keyword IDs, of the entries that must be deleted from the stock><\/p>\n
Keyword Stock API Keywords are critical metadata and Zoom offers some special Web APIs targeted towards keywords management. View Keyword Stock Request URL: Request JSON Syntax: The “data” parameter of the request is in JSON format. It must carry, apart from the command name i.e. cmd: getkwstock, a JSON object “message”, which will be interpreted by the […]<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"default","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"default","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[30],"tags":[],"class_list":["post-1937","post","type-post","status-publish","format-standard","hentry","category-api"],"yoast_head":"\n
Keyword Management Web API - Evolphin Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Keyword Management Web API - Evolphin Documentation\" \/>\n<meta property=\"og:description\" content=\"Keyword Stock API Keywords are critical metadata and Zoom offers some special Web APIs targeted towards keywords management. View Keyword Stock Request URL: Request JSON Syntax: The “data” parameter of the request is in JSON format. It must carry, apart from the command name i.e. cmd: getkwstock, a JSON object “message”, which will be interpreted by the […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Evolphin Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2014-12-15T13:06:27+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-05-18T15:15:26+00:00\" \/>\n<meta name=\"author\" content=\"Rahul Bhargava\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Rahul Bhargava\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/\"},\"author\":{\"name\":\"Rahul Bhargava\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/person\\\/e5f3dc53ac5f026ed258e224e75447f7\"},\"headline\":\"Keyword Management Web API\",\"datePublished\":\"2014-12-15T13:06:27+00:00\",\"dateModified\":\"2020-05-18T15:15:26+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/\"},\"wordCount\":427,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#organization\"},\"articleSection\":[\"API and Scripting\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/\",\"name\":\"Keyword Management Web API - Evolphin Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#website\"},\"datePublished\":\"2014-12-15T13:06:27+00:00\",\"dateModified\":\"2020-05-18T15:15:26+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/keyword-management-web-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/evolphin.com\\\/help\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Keyword Management Web API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#website\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/\",\"name\":\"Evolphin Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/evolphin.com\\\/help\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#organization\",\"name\":\"Evolphin Documentation\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/wp-content\\\/uploads\\\/2020\\\/04\\\/cropped-evolphin-logo-dolphin_sm.png\",\"contentUrl\":\"https:\\\/\\\/evolphin.com\\\/help\\\/wp-content\\\/uploads\\\/2020\\\/04\\\/cropped-evolphin-logo-dolphin_sm.png\",\"width\":200,\"height\":200,\"caption\":\"Evolphin Documentation\"},\"image\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/person\\\/e5f3dc53ac5f026ed258e224e75447f7\",\"name\":\"Rahul Bhargava\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g\",\"caption\":\"Rahul Bhargava\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Keyword Management Web API - Evolphin Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/","og_locale":"en_US","og_type":"article","og_title":"Keyword Management Web API - Evolphin Documentation","og_description":"Keyword Stock API Keywords are critical metadata and Zoom offers some special Web APIs targeted towards keywords management. View Keyword Stock Request URL: Request JSON Syntax: The “data” parameter of the request is in JSON format. It must carry, apart from the command name i.e. cmd: getkwstock, a JSON object “message”, which will be interpreted by the […]","og_url":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/","og_site_name":"Evolphin Documentation","article_published_time":"2014-12-15T13:06:27+00:00","article_modified_time":"2020-05-18T15:15:26+00:00","author":"Rahul Bhargava","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Rahul Bhargava","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/#article","isPartOf":{"@id":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/"},"author":{"name":"Rahul Bhargava","@id":"https:\/\/evolphin.com\/help\/#\/schema\/person\/e5f3dc53ac5f026ed258e224e75447f7"},"headline":"Keyword Management Web API","datePublished":"2014-12-15T13:06:27+00:00","dateModified":"2020-05-18T15:15:26+00:00","mainEntityOfPage":{"@id":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/"},"wordCount":427,"commentCount":0,"publisher":{"@id":"https:\/\/evolphin.com\/help\/#organization"},"articleSection":["API and Scripting"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/","url":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/","name":"Keyword Management Web API - Evolphin Documentation","isPartOf":{"@id":"https:\/\/evolphin.com\/help\/#website"},"datePublished":"2014-12-15T13:06:27+00:00","dateModified":"2020-05-18T15:15:26+00:00","breadcrumb":{"@id":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/evolphin.com\/help\/api\/keyword-management-web-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/evolphin.com\/help\/"},{"@type":"ListItem","position":2,"name":"Keyword Management Web API"}]},{"@type":"WebSite","@id":"https:\/\/evolphin.com\/help\/#website","url":"https:\/\/evolphin.com\/help\/","name":"Evolphin Documentation","description":"","publisher":{"@id":"https:\/\/evolphin.com\/help\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/evolphin.com\/help\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/evolphin.com\/help\/#organization","name":"Evolphin Documentation","url":"https:\/\/evolphin.com\/help\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/evolphin.com\/help\/#\/schema\/logo\/image\/","url":"https:\/\/evolphin.com\/help\/wp-content\/uploads\/2020\/04\/cropped-evolphin-logo-dolphin_sm.png","contentUrl":"https:\/\/evolphin.com\/help\/wp-content\/uploads\/2020\/04\/cropped-evolphin-logo-dolphin_sm.png","width":200,"height":200,"caption":"Evolphin Documentation"},"image":{"@id":"https:\/\/evolphin.com\/help\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/evolphin.com\/help\/#\/schema\/person\/e5f3dc53ac5f026ed258e224e75447f7","name":"Rahul Bhargava","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g","caption":"Rahul Bhargava"}}]}},"_links":{"self":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts\/1937","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/comments?post=1937"}],"version-history":[{"count":1,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts\/1937\/revisions"}],"predecessor-version":[{"id":14863,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts\/1937\/revisions\/14863"}],"wp:attachment":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/media?parent=1937"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/categories?post=1937"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/tags?post=1937"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}