{"info":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","description":"

The Micrometrics API permits the transfer and updating of Micrometrics data, returning JSON-encoded responses. It is organized around REST.

Authentication

What do I need to authenticate?

In order to authenticate, you will require a set of API Credentials. Each set of credentials permits certain permissions for the data that can be accessed. If you do not have them, please contact support@micrometrics.com and request Experience API Credentials.

How are authenticated requests made?

The Micrometrics API uses HMAC in order to verify the authenticity and identity of the request. With this, you do not need to send a username & password, nor will sending a request to an authentication endpoint be necessary. You simply will need to have a helper method to generate a request signature that is sent as a header in your request.

Ensure each of your requests contains the following header:

Key: Authorization

Value: APIAuth (your_api_key):(your_request_signature)

Generating a Request Signature

The format for the request signature is:
Base64(HmacSHA1(request_method,content_type,content,resource_uri,timestamp, your_api_secret))

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Type	Examples
request_method	The method you are operating on for the given endpoint.	String	\"GET\", \"POST\", \"PUT\"
content_type	The content type of your request. For now, this is done in JSON	String	\"application/json\"
content	A Base64-encoded MD5 hash of the body of your request. Leave this blank if there is no body (eg: GET requests)	String	\"ODdFNzcxMUM5Rjk1NzMzNkRFMEU4RTlDMTUyMzQ2NTE=\"
resource_uri	The resource you are acting on.	String	\"/api/experience/devices/{device_id}\"
Timestamp	The current timestamp of the time you are making this request. We use this to ensure old request signatures cannot be re-used	String	\"Fri, 04 Sep 2020 13:35:05 GMT\"

Examples of Request Signatures

GET a device with the hash of Tgc9VyKJ-8a9-89uV7wwVc:
Base64(HmacSHA1(\"GET,application/json,,/api/experience/devices/Tgc9VyKJ-8a9-89uV7wwVc,Fri, 04 Sep 2020 13:35:05 GMT\", your_api_secret))

POST a survey response to survey with the ID of 237:

Base64(HmacSHA1(\"POST,application/json,0/nBW1QKiUuBw1ghZBwkpg==,/api/experience/surveys/237/responses,Fri, 04 Sep 2020 13:43:56 GMT\",your_api_secret))

Pagination

API responses are paginated using a cursor. When you request an index page for a resource, the response will contain a Next-Cursor header. To fetch the next page, set the cursor parameter on your next request to the value of this header.

If a response does not have the Next-Cursor header, or if it is empty, then there are no further records to be fetched.

Request Throttling

API clients are limited in the number of requests they can make in a short period of time. If a client exceeds that limit, requests they make will fail with an HTTP 429: Too Many Requests error.

Our throttles are based on a leaky bucket algorithm. Each client has a bucket, and each API request adds a token to the bucket. The bucket 'leaks' at a certain rate, making room for more tokens. If the bucket gets full then further requests cannot be made until there is room in the bucket.

This means that a client can make a burst of requests that fill the bucket faster than it is being emptied, but only to a point. After that they must wait.

By default, API clients have room in their bucket for 10 tokens, and it leaks at a rate of 1 token every second. Every HTTP request adds a single token to the bucket.

The following response headers contain details on your client's current throttling.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value
`RateLimit-Rate`	How many requests per second your client supports
`RateLimit-Burst-Remaining`	How many more requests your client can make in a short period before being throttled
`RateLimit-Retry-After`	How long your client needs to wait after being throttled before requests will succeed again.

Global URL Parameters

Some URL Parameters can be used on any request. The following can be used:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Example	Description
start_at	\"2020-09-05T23:59:59.999-04:00\"	Limits resource results to after the start_at value. Defaults to 1 month before end of day of today
end_at	\"2020-10-05T23:59:59.999-04:00\"	Limits resource results to before the end_at value. Defaults to end of day of today

FAQ

I keep receiving a 401 unauthorized status, yet my API Key and Secret are correct

Ensure you are generating your request signature correctly from the section above
\n

Ensure you have the correct default headers. We recommend having the three:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value	Example
Date	`{CurrentDateTime}`	Wed, 09 Sep 2020 21:27:25 GMT
Content-Type	application/json	application/json
Authentication	APIAuth `{your_key}`:`{request_signature}`	APIAuth OaDNzi:fefNiwRCXbKgypGYDNIgPJ3FDrJns4c2++GThu=

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Pagination","slug":"pagination"},{"content":"Request Throttling","slug":"request-throttling"},{"content":"Global URL Parameters","slug":"global-url-parameters"},{"content":"FAQ","slug":"faq"}],"owner":"19265575","collectionId":"754c78b3-6a94-47f6-9825-34e50966bf24","publishedId":"2sBXqKqLe5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-04T20:55:49.000Z"},"item":[{"name":"Answers","item":[{"name":"Answers","id":"73e5d0d2-96af-4467-a091-f46d4e4e1c38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"/questions/:question_id/answers","description":"

Return a list of answers for a particular survey

Return a single answer

Return all available answers for the given credentials

\n","_postman_id":"6fbdf12f-1982-4492-a25e-ecaad8d02e1d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Devices","item":[{"name":"Device","id":"7d603601-c6ef-4c9b-ab5c-565d3c4dbeb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"/devices/:hash","description":"

Get a single device based on its hash. The Device Hash is a unique identifier that can be used on URLs to request a given device.

It also contains pertinent metadata related to the device, such as the name of the default survey associated with it, last updated, and the rules surrounding the survey to show based on number of connection times for that user.

Devices are access points that reside within a given location. For example, these could be WiFi routers or iPads that are used to dispatch a survey to customers.

\n","_postman_id":"bb231e1a-5d45-4de4-8744-75d0312e5d20","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Locations","item":[{"name":"Location","id":"653e673d-bbc0-42de-b8c7-59f90493f5ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Connection-Type","value":"application/json","type":"text"}],"url":"/locations/:id","description":"

Returns a single location. This returns pertinent metadata such as location name, address, and associated device IDs.

The ID corresponding to our target survey

\n","type":"text/plain"},"type":"string","value":"{{location_id}}","key":"id"}]}},"response":[{"id":"5b2d6a1e-3e3f-464b-a53d-fdf09535f8ad","name":"Location","originalRequest":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"APIAuth 1trfD0G93fr2:F=4wqg54m35g543==","type":"text"}],"url":{"raw":"/locations/:id","host":[""],"path":["locations",":id"],"variable":[{"key":"id","value":"{{location_id}}","type":"string","description":"The ID corresponding to our target survey"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"location\": {\n \"name\": \"Default Location\",\n \"address\": {\n \"id\": 2,\n \"address_line_1\": \"123 Test Street\",\n \"address_line_2\": \"Unit 5\",\n \"city\": \"Toronto\",\n \"province\": \"Ontario\",\n \"country\": \"CA\",\n \"postal_code\": \"K1K0F0\",\n \"telephone\": \"1231231234\",\n \"fax\": \"9991119999\",\n \"created_at\": \"2018-07-31T14:39:18.217Z\",\n \"updated_at\": \"2020-09-09T20:24:33.169Z\"\n },\n \"devices\": [\n 93,\n 22,\n 13\n ]\n }\n}"}],"_postman_id":"653e673d-bbc0-42de-b8c7-59f90493f5ef"},{"name":"Location Devices","id":"e52f98f4-c6a4-4aca-8090-cbe585ea673a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"/locations/:location_id/devices","description":"

Retrieves a list of devices belonging to a given location

Return all locations for the requested account

A location represents a physical place. They have a name and often contain one or more associated devices.

For example, The Empire State Building (Location) may have numerous WiFi access points (Devices).

\n","_postman_id":"f3706942-7979-41ec-8701-9d175fe38397","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Questions","item":[{"name":"Question","id":"ac0a3fdf-6f76-4600-9be7-0001de7ca0cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Date","type":"text","value":"{{httpdate}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"/questions/:question_id","description":"

Return single question by ID

Return all questions available to the current credentials

Return a list of answers associated with the specified question

Return a list of translations for the specified question

Requests within this resource section relate to survey questions.

\n","event":[{"listen":"prerequest","script":{"id":"b014bc44-7a9f-4c27-b397-f27946c21d20","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5449e406-81e6-40a7-9cd2-da4690ed9417","type":"text/javascript","exec":[""]}}],"_postman_id":"e4872293-6b6a-40c4-9d11-e9d8703f0aca","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Responses","item":[{"name":"Responses","id":"10e479de-559d-4186-ab99-3be5cd15d1f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"type":"multiplechoice","subtype":"mc_short","options":{"fields":[251,252,253,254]},"created_at":"2020-09-28T19:18:59.062Z","updated_at":"2020-09-28T19:18:59.472Z","key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{httpdate}}","type":"text"}],"url":"/responses","description":"

Returns a list of responses available to the credentials

These resources act on survey responses

\n","event":[{"listen":"prerequest","script":{"id":"883c5f87-2738-4bf9-9b54-6c82f367ec85","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45ef02ae-f511-4d48-875c-012771cfef1a","type":"text/javascript","exec":[""]}}],"_postman_id":"f6618ab7-a74f-4ced-bd07-e24368ee3dcb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Surveys","item":[{"name":"Survey","event":[{"listen":"prerequest","script":{"id":"2877fb6b-8338-471e-85bb-fad2c044979a","exec":[""],"type":"text/javascript"}}],"id":"1e9170d9-caa9-4819-96a1-6e80c8970630","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Date","value":"{{httpdate}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/surveys/:id?lang=en","description":"

Retrieves a survey object. This includes the corresponding survey logic, survey theme, and questions.

Get the translations available for the requested survey ID

The survey ID we would like an array of translations for

\n","type":"text/plain"},"type":"string","value":"{{survey_id}}","key":"id"}]}},"response":[{"id":"97274f57-3d4a-4087-9bc9-0e3c56d507d4","name":"Survey Translations","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIAuth 1trfD0G93fr2:F=4wqg54m35g543==","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Date","value":"{{httpdate}}","type":"text"}],"url":{"raw":"/survey/:id/translations","host":[""],"path":["survey",":id","translations"],"variable":[{"key":"id","value":"{{survey_id}}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"en\": {\n \"id\": {{survey_id}},\n \"questions\": [\n {\n \"question_id\": 4901,\n \"translations\": [{\n \t\"key\": \"title\",\n \t\"value\": \"How did you enjoy your experience at Hyatt Regency Toronto?\"\n },\n {\n \t\"key\": \"content\",\n \t\"value\": \"Please fill out the details below in order to obtain a Wifi connection\"\n },\n {\n \t\"key\": \"option1\",\n \t\"value\": \"awful\"\n },\n {\n \t\"key\": \"option2\",\n \t\"value\": \"bad\"\n },\n {\n \t\"key\": \"option3\",\n \t\"value\": \"neutral\"\n },\n {\n \t\"key\": \"option4\",\n \t\"value\": \"good\"\n },\n {\n \t\"key\": \"option5\",\n \t\"value\": \"amazing\"\n }]\n },\n {\n \"question_id\": 4902,\n \"translations\": [{\n \t\"key\": \"title\",\n \t\"value\": \"We're glad you enjoyed your stay. What could we do better?\"\n },\n {\n \t\"key\": \"placeholder\",\n \t\"value\": \"Write your answer here...\"\n }]\n },\n {\n \"question_id\": 4903,\n \"translations\": [\n \t{\n \"key\": \"title\",\n \"value\": \"What did you enjoy the most?\"\n },\n {\n \"key\": \"option610\",\n \"value\": \"Comfort\"\n },\n {\n \"key\": \"option611\",\n \"value\": \"Room Service\"\n },\n {\n \"key\": \"option612\",\n \"value\": \"Cleanliness\"\n },\n {\n \"key\": \"option613\",\n \"content\": \"Price\"\n }\n ]\n }\n ],\n \"meta\": {\n \"before_logo\": \"Hyatt Regency Toronto\",\n \"submit\": \"Submit\",\n \"skip_question\": \"Skip this question\",\n \"skipped_question\": \"You skipped this question\",\n \"language_heading\": \"Select Language\",\n \"policy_text\": \"By proceeding you agree to the Helix Privacy Policy and Cookie Policy\",\n \"no_thanks\": \"No Thanks\",\n \"thank_you\": {\n \"title\": \"Thank you for helping us serve you better!\",\n \"content\": \"Enjoy your stay at The Abu Dhabi Edition.\"\n },\n \"email\": {\n \"title\": \"Thank you for agreeing to write a review. Please provide your email address so we can send you a review link.\",\n \"placeholder\": \"Enter your email address here...\",\n \"optin_flag\": \"By checking this box, you agree to provide your contact information to MicroMetrics Demo Hotel to follow-up with you as described in our Helix Privacy Policy\",\n \"button_text\": \"Next\"\n }\n }\n },\n \"fr\": {}\n}"}],"_postman_id":"3c907b1d-9105-49b2-9747-db18e74ec70e"},{"name":"Survey Translation Locale","id":"0c77e0aa-1ba8-448b-93b4-abfeafe670b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Date","value":"{{httpdate}}","type":"text"}],"url":"/surveys/:id/translations/:locale","description":"

The Survey Translation request, with a specific locale

The ID of the target survey

\n","type":"text/plain"},"type":"string","value":"{{survey_id}}","key":"id"},{"id":"8f8a2177-f410-4a2d-8bbb-6f4773443cbe","description":{"content":"

The locale code (\"en\", \"fr\", etc...) of the language we're requesting

\n","type":"text/plain"},"type":"string","value":"fr","key":"locale"}]}},"response":[{"id":"c8cfdfc7-7bb9-45f8-9485-3a6d5ffd0301","name":"Survey Translation Locale","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIAuth 1trfD0G93fr2:F=4wqg54m35g543==","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Date","value":"{{httpdate}}","type":"text"}],"url":{"raw":"/survey/:id/translations/:locale","host":[""],"path":["survey",":id","translations",":locale"],"variable":[{"key":"id","value":"{{survey_id}}"},{"key":"locale","value":"en"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": {{survey_id}},\n \"questions\": [{\n \t\"question_id\": 4901,\n \t\"translations\": [\n \t\t{\n \t\t\t\"key\": \"title\",\n \t\t\t\"value\": \"How did you enjoy your experience at Hyatt Regency Toronto?\"\n \t\t},\n \t\t{\n\t \t\t\"key\": \"content\",\n\t \t\t\"value\": \"Please fill out the details below in order to obtain a Wifi connection\"\n \t\t},\n \t\t{\n\t \t\t\"key\": \"option1\",\n\t \t\t\"value\": \"awful\"\n \t\t},\n \t\t{\n\t \t\t\"key\": \"option2\",\n\t \t\t\"value\": \"bad\"\n \t\t},\n \t\t{\n\t \t\t\"key\": \"option3\",\n\t \t\t\"value\": \"neutral\"\n \t\t},\n \t\t{\n\t \t\t\"key\": \"option4\",\n\t \t\t\"value\": \"good\"\n \t\t},\n \t\t{\n\t \t\t\"key\": \"option5\",\n\t \t\t\"value\": \"amazing\"\n \t\t}\n \t]\n },\n {\n \t\"question_id\": 4902,\n \t\"translations\": [\n \t\t{\n\t \t\t\"key\": \"title\",\n\t \t\t\"value\": \"We're glad you enjoyed your stay. What could we do better?\"\n \t\t},\n \t\t{\n \t\t\t\"key\": \"content\",\n\t \t\t\"value\": null\n \t\t},\n \t\t{\n \t\t\t\"key\": \"placeholder\",\n\t \t\t\"value\": \"Write your answer here...\"\n \t\t}]\n },\n {\n \t\"question_id\": 4903,\n \t\"translations\": [\n\t\t\t{\n\t \t\t\"key\": \"title\",\n\t \t\t\"value\": \"What did you like most?\"\n \t\t},\n \t\t{\n \t\t\t\"key\": \"content\",\n \t\t\t\"value\": null\n \t\t},\n \t\t{\n\t \t\t\"key\": \"placeholder\",\n\t \t\t\"value\": null\n \t\t},\n \t\t{\n\t \t\t\"key\": \"option610\",\n\t \t\t\"value\": \"Comfort\"\n\t \t},\n\t \t{\n\t \t\t\"key\": \"option611\",\n\t \t\t\"value\": \"Room Service\"\n\t \t},\n\t \t{\n\t \t\t\"key\": \"option612\",\n\t \t\t\"value\": \"Cleanliness\"\n\t \t},\n\t \t{\n\t \t\t\"key\": \"option613\",\n\t \t\t\"value\": \"Price\"\n \t\t}]\n }],\n \"meta\": {\n\t \"before_logo\": \"Hyatt Regency Toronto\",\n\t \"submit\": \"Submit\",\n\t \"skip_question\": \"Skip this question\",\n\t \"skipped_question\": \"You skipped this question\",\n\t \"language_heading\": \"Select Language\",\n\t \"policy_text\": \"By proceeding you agree to the Helix Privacy Policy and Cookie Policy\",\n\t \"no_thanks\": \"No Thanks\",\n\t \"thank_you_title\": \"Thank you for helping us serve you better!\",\n\t \"thank_you_content\": \"Enjoy your stay at The Abu Dhabi Edition.\",\n\t \"email_title\": \"Thank you for agreeing to write a review.\",\n\t \"email_content\": \"Please provide your email address so we can send you a review link.\",\n\t \"email_placeholder\": \"Enter your email address here...\",\n\t \"email_optin_flag\": \"By checking this box, you agree to provide your contact information to MicroMetrics Demo Hotel to follow-up with you as described in our Helix Privacy Policy\",\n\t \"email_button_text\": \"Next\"\n\t}\n}"}],"_postman_id":"0c77e0aa-1ba8-448b-93b4-abfeafe670b3"},{"name":"Surveys","id":"f59d0aff-fe19-4835-8389-b0468e955b52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/surveys/","description":"

Returns all available surveys

Surveys are an array of questions deployed over a Device. They each have questions, logic rules, a name, settings, and a corresponding Survey Translation for the requested language.

\n","_postman_id":"9d5e1c7b-20c6-442d-99f4-de5bca42be91","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Issues","item":[{"name":"Create Issue","id":"22c1c453-9a6e-4507-9456-b53c35d2be88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization-Content-SHA256","value":"{{contentSHA256}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 1,\n \"description\": \"Comfort: 2 Pillows\",\n \"source\": \"in_room_tablet\",\n \"name\": \"Jane Doe\",\n \"room\": \"504\",\n \"priority_level\": 2,\n \"owner_ids\": [\n \"3\"\n ],\n \"group_ids\": [\n \"2\"\n ],\n \"tag_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":"/issues","description":"

Creates an alert (issue) in the specified account using a partner credential (App::MultiAccountCredential).

Required fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`account_id`	integer	Must be in the credential's `scope.accounts`. Out-of-scope or missing returns 404.
`description`	string	The alert text. Required for partner-created alerts.
`source`	string	Must be in `Issue::PARTNER_ALLOWED_SOURCES` (currently only `in_room_tablet`).

Optional fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`name`	string	Guest name; rendered on the alert card.
`room`	string	Room or location label.
`priority_level`	integer	1 (low), 2 (normal), 3 (high). Defaults to 2.
`owner_ids`	array of integers	Users to assign in the resolved account. Out-of-scope IDs are silently dropped.
`group_ids`	array of integers	Groups to assign in the resolved account.
`tag_ids`	array of integers	Tags to attach. Each tag's `tag_category.account_id` must match the resolved account.

Where to get IDs

To populate the optional ID arrays, use the partner-reachable read endpoints:

owner_ids[] → Users → List users (GET /users?account_id=1)
\n
group_ids[] → Groups → List groups (GET /groups?account_id=1)
\n
tag_ids[] → Tags → List tags (GET /tags?account_id=1)
\n

Each list response includes account_id per row so you can disambiguate when the credential spans multiple accounts.

account_id itself is not API-discoverable, it is set on your credential's scope.accounts server-side and shared with you out-of-band when the credential is provisioned.

Response

200 OK : returns the created alert payload. creator_id is always null on partner-created alerts, attribution lives on created_by_app_id server-side.
\n
404 Not Found account_id missing, out of credential scope or alerts feature flag disabled on the resolved account.
\n
422 Unprocessable Entity : description missing, source missing or source not in the allow-list.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}},"urlObject":{"path":["issues"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"94e49b13-37f2-4bd2-a245-675e47facaf2","name":"Create Issue with minimal parameters","originalRequest":{"method":"POST","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization-Content-SHA256","value":"{{contentSHA256}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 1,\n \"description\": \"Comfort: 2 Pillows\",\n \"source\": \"in_room_tablet\"\n}","options":{"raw":{"language":"json"}}},"url":"/issues"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"RateLimit-Rate","value":"1.0"},{"key":"RateLimit-Burst-Remaining","value":"9"},{"key":"RateLimit-Retry-After","value":"1.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Git-Revision","value":"349162d37fd75c5ac0e3f92f3e88f26718ef80e7"},{"key":"X-Git-Revision-Date","value":"2026-05-04T07:46:44-04:00"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"ETag","value":"W/\"a9c97ed8f4d2ad8c99437922a6eceb8d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"4079b349-0e3b-4e23-af72-9ff5ec6b865c"},{"key":"X-Runtime","value":"0.110250"},{"key":"vary","value":"Origin"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Security-Policy-Report-Only","value":"default-src 'self' https:; connect-src 'self' wss://api.appcues.net wss://ws-mt1.pusher.com ekr.zdassets.com micrometrics.zendesk.com www.google-analytics.com; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' https:; style-src 'self' 'unsafe-inline'"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 143,\n \"type\": \"GuestIssue\",\n \"alert_id\": null,\n \"hash_id\": \"07dc8abb3a7f482c2cbd25fd82156dae\",\n \"creator_id\": null,\n \"created_by_app_id\": 6,\n \"created_at\": \"2026-05-04T15:06:27.913Z\",\n \"updated_at\": \"2026-05-04T15:06:27.939Z\",\n \"origin\": \"In room tablet\",\n \"state\": \"open\",\n \"closed\": false,\n \"priority\": \"normal\",\n \"priority_level\": 2,\n \"details\": {\n \"guest\": \"\",\n \"room\": \"\",\n \"description\": \"Comfort: 2 Pillows\",\n \"rating\": null\n },\n \"owners\": {\n \"users\": [],\n \"groups\": []\n },\n \"guest\": {\n \"id\": 132,\n \"hash_id\": \"7ddd1884286a3ef5c16b9d786a90f6e6\",\n \"title\": null,\n \"email\": null,\n \"phone\": null,\n \"phone_source\": null,\n \"phone_validation\": \"unvalidated\",\n \"send_sms\": false,\n \"phone_alpha2\": null,\n \"block\": null,\n \"created_at\": \"2026-05-04T15:06:27.909Z\",\n \"names\": [],\n \"emails\": [],\n \"bookings\": [],\n \"active_conversation\": false\n },\n \"hotsos_service_orders\": [],\n \"attachments\": [],\n \"conversation_id\": 205,\n \"participants\": [\n {\n \"id\": 3,\n \"account_id\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"user_name\": \"john.doe@example.com\",\n \"email\": \"john.doe@example.com\",\n \"deactivated_at\": null,\n \"has_mobile\": false,\n \"groups\": [\n 2\n ]\n },\n {\n \"id\": 2,\n \"account_id\": 2,\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"user_name\": \"jane.doe@example.com\",\n \"email\": \"jane.doe@example.com\",\n \"deactivated_at\": null,\n \"has_mobile\": true,\n \"groups\": [\n 2\n ]\n }\n ]\n}"},{"id":"712a3442-b327-4bec-aff2-5def7ca2f004","name":"Create Issue","originalRequest":{"method":"POST","header":[{"key":"Date","value":"{{httpdate}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization-Content-SHA256","value":"{{contentSHA256}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 1,\n \"description\": \"Comfort: 2 Pillows\",\n \"source\": \"in_room_tablet\",\n \"name\": \"Juliette Smith\",\n \"room\": \"504\",\n \"priority_level\": 2,\n \"owner_ids\": [\n \"3\"\n ],\n \"group_ids\": [\n \"2\"\n ],\n \"tag_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":"/issues"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"RateLimit-Rate","value":"1.0"},{"key":"RateLimit-Burst-Remaining","value":"9"},{"key":"RateLimit-Retry-After","value":"1.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Git-Revision","value":"349162d37fd75c5ac0e3f92f3e88f26718ef80e7"},{"key":"X-Git-Revision-Date","value":"2026-05-04T07:46:44-04:00"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"ETag","value":"W/\"e5a3b766aee9c513828fb9a1f9a6ee92\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"90fa9753-3cc8-4a7f-bee2-d11471483320"},{"key":"X-Runtime","value":"0.147367"},{"key":"vary","value":"Origin"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Security-Policy-Report-Only","value":"default-src 'self' https:; connect-src 'self' wss://api.appcues.net wss://ws-mt1.pusher.com ekr.zdassets.com micrometrics.zendesk.com www.google-analytics.com; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' https:; style-src 'self' 'unsafe-inline'"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 142,\n \"type\": \"GuestIssue\",\n \"alert_id\": null,\n \"hash_id\": \"2c2c3eb5b2af188cd84e523ecbdffefc\",\n \"creator_id\": null,\n \"created_by_app_id\": 6,\n \"created_at\": \"2026-05-04T15:05:21.255Z\",\n \"updated_at\": \"2026-05-04T15:05:21.283Z\",\n \"origin\": \"In room tablet\",\n \"state\": \"pending\",\n \"closed\": false,\n \"priority\": \"normal\",\n \"priority_level\": 2,\n \"details\": {\n \"guest\": \"Juliette Smith\",\n \"room\": \"504\",\n \"description\": \"Comfort: 2 Pillows\",\n \"rating\": null\n },\n \"owners\": {\n \"users\": [\n {\n \"id\": 3,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n ],\n \"groups\": [\n {\n \"id\": 2,\n \"name\": \"Alert Notification List\"\n }\n ]\n },\n \"guest\": {\n \"id\": 131,\n \"hash_id\": \"632cc18b76f21ee9b2bae17d9418b79e\",\n \"title\": null,\n \"email\": null,\n \"phone\": null,\n \"phone_source\": null,\n \"phone_validation\": \"unvalidated\",\n \"send_sms\": false,\n \"phone_alpha2\": null,\n \"block\": null,\n \"created_at\": \"2026-05-04T15:05:21.241Z\",\n \"names\": [\n {\n \"id\": 70,\n \"name\": \"Juliette Smith\",\n \"title\": null,\n \"source\": \"1-staff\",\n \"primary\": false,\n \"created_at\": \"2026-05-04T15:05:21.243Z\",\n \"updated_at\": \"2026-05-04T15:05:21.243Z\"\n }\n ],\n \"emails\": [],\n \"bookings\": [],\n \"active_conversation\": false\n },\n \"hotsos_service_orders\": [],\n \"attachments\": [],\n \"conversation_id\": 204,\n \"participants\": [\n {\n \"id\": 3,\n \"account_id\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"user_name\": \"john.doe@example.com\",\n \"email\": \"john.doe@example.com\",\n \"deactivated_at\": null,\n \"has_mobile\": false,\n \"groups\": [\n 2\n ]\n },\n {\n \"id\": 2,\n \"account_id\": 2,\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"user_name\": \"jane.doe@example.com\",\n \"email\": \"jane.doe@example.com\",\n \"deactivated_at\": null,\n \"has_mobile\": true,\n \"groups\": [\n 2\n ]\n }\n ]\n}"}],"_postman_id":"22c1c453-9a6e-4507-9456-b53c35d2be88"}],"id":"14897d58-a8e2-4a21-b39a-603f79c3b5a5","description":"

Endpoints for creating and managing alerts (issues) on partner-scoped accounts.

Partner credentials (App::MultiAccountCredential) currently support alert creation only. The account_id body field selects which scoped account the alert lands in.

\n","_postman_id":"14897d58-a8e2-4a21-b39a-603f79c3b5a5","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Users","item":[{"name":"List users","id":"335d66e2-5679-d15d-2e68-1a7cdcdedb1e","request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}"},{"key":"Content-Type","value":"application/json"}],"url":"/users?account_id=1","description":"

Lists active users across the credential's scoped accounts. Each user payload includes account_id so you can filter client-side to a specific account.

Use with Create Issue

Use the returned id values for owner_ids[] on Create Issue. The Create Issue endpoint scopes owner_ids to the resolved account_id server-side, IDs that belong to other scoped accounts are silently dropped.

Users are staff members within an account who can be assigned alerts. List endpoints return active (non-deactivated) users only and include account_id per row so partner credentials spanning multiple accounts can disambiguate.

\n","_postman_id":"a9822b9b-295d-0f9b-b7b2-f4a5f6acfcc4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Groups","item":[{"name":"List groups","id":"390147b6-92d5-0eea-e6ce-c54e79aaeefc","request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}"},{"key":"Content-Type","value":"application/json"}],"url":"/groups?account_id=1","description":"

Lists groups across the credential's scoped accounts. Each group payload includes account_id so you can filter client-side to a specific account.

Use with Create Issue

Use the returned id values for group_ids[] on Create Issue. The Create Issue endpoint scopes group_ids to the resolved account_id server-side, out-of-account IDs are silently dropped.

Groups are collections of users within an account (e.g. \"Front Desk\", \"Maintenance\"). Alerts can be assigned to a group, which fans out the assignment to every member. List payloads include account_id per row.

\n","_postman_id":"003686fa-65ba-02ba-31a6-89a2c6a1e6f4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}},{"name":"Tags","item":[{"name":"List tags","id":"58c603dc-b3e0-b26b-3943-37bc1b769f76","request":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}"},{"key":"Content-Type","value":"application/json"}],"url":"/tags?account_id=1","description":"

Lists tags across the credential's scoped accounts. Each tag belongs to a tag_category whose account_id determines its scope.

Use with Create Issue

Use the returned id values for tag_ids[] on Create Issue. Tags whose tag_category.account_id doesn't match the resolved account_id are silently rejected server-side.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}},"urlObject":{"path":["tags"],"host":[""],"query":[{"key":"account_id","value":"1"}],"variable":[]}},"response":[{"id":"a341f872-6756-4429-8b96-45bc2d160f72","name":"List tags","originalRequest":{"method":"GET","header":[{"key":"Date","value":"{{httpdate}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"/tags?account_id=1","host":[""],"path":["tags"],"query":[{"key":"account_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"RateLimit-Rate","value":"1.0"},{"key":"RateLimit-Burst-Remaining","value":"9"},{"key":"RateLimit-Retry-After","value":"1.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Git-Revision","value":"349162d37fd75c5ac0e3f92f3e88f26718ef80e7"},{"key":"X-Git-Revision-Date","value":"2026-05-04T07:46:44-04:00"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"ETag","value":"W/\"380f15d2a5cdd49661912853ca17f3e7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0307fc3c-9f11-4f7e-82b8-5e37816d5ae0"},{"key":"X-Runtime","value":"0.057400"},{"key":"vary","value":"Origin"},{"key":"X-Frame-Options","value":"sameorigin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Content-Security-Policy-Report-Only","value":"default-src 'self' https:; connect-src 'self' wss://api.appcues.net wss://ws-mt1.pusher.com ekr.zdassets.com micrometrics.zendesk.com www.google-analytics.com; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' https:; style-src 'self' 'unsafe-inline'"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 26,\n \"account_id\": 2,\n \"name\": \"Decor\",\n \"keywords\": [\n \"decor\",\n \"carpet\",\n \"lighting\",\n \"lighting\",\n \"corridor\",\n \"hall\",\n \"hallway\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 7,\n \"created_at\": \"2024-11-11T14:45:10.937Z\"\n },\n {\n \"id\": 27,\n \"account_id\": 2,\n \"name\": \"Internet\",\n \"keywords\": [\n \"internet\",\n \"wifi\",\n \"wi-fi\",\n \"connection\",\n \"log in\",\n \"website\",\n \"authentication\",\n \"password\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 7,\n \"created_at\": \"2024-11-11T14:45:10.942Z\"\n },\n {\n \"id\": 28,\n \"account_id\": 2,\n \"name\": \"Parking\",\n \"keywords\": [\n \"parking\",\n \"lot\",\n \"shuttle\",\n \"valet\",\n \"car park\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 7,\n \"created_at\": \"2024-11-11T14:45:10.946Z\"\n },\n {\n \"id\": 29,\n \"account_id\": 2,\n \"name\": \"Staff\",\n \"keywords\": [\n \"staff\",\n \"associates\",\n \"housekeeper\",\n \"bellman\",\n \"front desk\",\n \"concierge\",\n \"employee\",\n \"employees\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 7,\n \"created_at\": \"2024-11-11T14:45:10.949Z\"\n },\n {\n \"id\": 30,\n \"account_id\": 2,\n \"name\": \"Bell Staff\",\n \"keywords\": [\n \"bags\",\n \"luggage\",\n \"bellman\",\n \"doorman\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.958Z\"\n },\n {\n \"id\": 31,\n \"account_id\": 2,\n \"name\": \"Billing/Rates\",\n \"keywords\": [\n \"pricy\",\n \"pricey\",\n \"expensive\",\n \"price\",\n \"rate\",\n \"rates\",\n \"charge\",\n \"free\",\n \"paid\",\n \"nickel\",\n \"expense\",\n \"payment\",\n \"credit card\",\n \"billing\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.962Z\"\n },\n {\n \"id\": 32,\n \"account_id\": 2,\n \"name\": \"Check-In\",\n \"keywords\": [\n \"checkin\",\n \"check-in\",\n \"front desk\",\n \"checking in\",\n \"check in\",\n \"not ready\",\n \"on arrival\",\n \"key didn't work\",\n \"room ready\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.966Z\"\n },\n {\n \"id\": 33,\n \"account_id\": 2,\n \"name\": \"Noise\",\n \"keywords\": [\n \"noise\",\n \"noisey\",\n \"noisy\",\n \"loud\",\n \"construction\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.969Z\"\n },\n {\n \"id\": 34,\n \"account_id\": 2,\n \"name\": \"Reservations\",\n \"keywords\": [\n \"reservation\",\n \"reservations\",\n \"charge\",\n \"charged\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.972Z\"\n },\n {\n \"id\": 35,\n \"account_id\": 2,\n \"name\": \"Rewards\",\n \"keywords\": [\n \"member\",\n \"platinum\",\n \"elite\",\n \"rewards\",\n \"gold\",\n \"spg\",\n \"upgrade\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.976Z\"\n },\n {\n \"id\": 36,\n \"account_id\": 2,\n \"name\": \"Room Location/Type\",\n \"keywords\": [\n \"room\",\n \"walk\",\n \"view\",\n \"next door\",\n \"too close\",\n \"too far\",\n \"closet\",\n \"desk\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 8,\n \"created_at\": \"2024-11-11T14:45:10.979Z\"\n },\n {\n \"id\": 37,\n \"account_id\": 2,\n \"name\": \"Bathroom\",\n \"keywords\": [\n \"toilet\",\n \"bathtub\",\n \"towels\",\n \"mirror\",\n \"tile\",\n \"tub\",\n \"sink\",\n \"shower\",\n \"water\",\n \"bathroom\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 9,\n \"created_at\": \"2024-11-11T14:45:10.987Z\"\n },\n {\n \"id\": 38,\n \"account_id\": 2,\n \"name\": \"Beds\",\n \"keywords\": [\n \"beds\",\n \"mattress\",\n \"bed\",\n \"sheet\",\n \"duvet\",\n \"comforter\",\n \"pillow\",\n \"foam\",\n \"sham\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 9,\n \"created_at\": \"2024-11-11T14:45:11.034Z\"\n },\n {\n \"id\": 39,\n \"account_id\": 2,\n \"name\": \"Cleanliness/Housekeeping\",\n \"keywords\": [\n \"cleanliness\",\n \"dirty\",\n \"clean\",\n \"housekeeping\",\n \"housekeeper\",\n \"refresh\",\n \"stain\",\n \"stains\",\n \"cleaned\",\n \"vacuum\",\n \"cleaning\",\n \"cleaner\",\n \"cleaners\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 9,\n \"created_at\": \"2024-11-11T14:45:11.039Z\"\n },\n {\n \"id\": 40,\n \"account_id\": 2,\n \"name\": \"Towels\",\n \"keywords\": [\n \"towel\",\n \"towels\",\n \"robe\",\n \"robes\",\n \"facecloth\",\n \"facecloths\",\n \"washcloth\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 9,\n \"created_at\": \"2024-11-11T14:45:11.044Z\"\n },\n {\n \"id\": 41,\n \"account_id\": 2,\n \"name\": \"Room Smell\",\n \"keywords\": [\n \"odor\",\n \"odors\",\n \"odour\",\n \"odours\",\n \"smell\",\n \"smells\",\n \"stink\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 9,\n \"created_at\": \"2024-11-11T14:45:11.048Z\"\n },\n {\n \"id\": 42,\n \"account_id\": 2,\n \"name\": \"Heating/Cooling\",\n \"keywords\": [\n \"hot\",\n \"cold\",\n \"cool\",\n \"warm\",\n \"air conditioner\",\n \"heat\",\n \"AC\",\n \"A/C\",\n \"air conditioning\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 10,\n \"created_at\": \"2024-11-11T14:45:11.056Z\"\n },\n {\n \"id\": 43,\n \"account_id\": 2,\n \"name\": \"Hotel/Room Maintenance\",\n \"keywords\": [\n \"air conditioner\",\n \"A/C\",\n \"lights\",\n \"lighting\",\n \"lamp\",\n \"leak\",\n \"pressure\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 10,\n \"created_at\": \"2024-11-11T14:45:11.060Z\"\n },\n {\n \"id\": 44,\n \"account_id\": 2,\n \"name\": \"Recreation Facilities\",\n \"keywords\": [\n \"facilities\",\n \"recreation\",\n \"spa\",\n \"pool\",\n \"gym\",\n \"lounge\",\n \"bar\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 10,\n \"created_at\": \"2024-11-11T14:45:11.064Z\"\n },\n {\n \"id\": 45,\n \"account_id\": 2,\n \"name\": \"Telephone\",\n \"keywords\": [\n \"phone\",\n \"call\",\n \"calling\",\n \"telephone\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 10,\n \"created_at\": \"2024-11-11T14:45:11.067Z\"\n },\n {\n \"id\": 46,\n \"account_id\": 2,\n \"name\": \"TV/Remote\",\n \"keywords\": [\n \"television\",\n \"TV\",\n \"pay-per-view\",\n \"PPV\",\n \"movie\",\n \"cable\",\n \"channels\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 10,\n \"created_at\": \"2024-11-11T14:45:11.071Z\"\n },\n {\n \"id\": 47,\n \"account_id\": 2,\n \"name\": \"Restaurant\",\n \"keywords\": [\n \"restaurant\",\n \"server\",\n \"waiter\",\n \"service\",\n \"bartender\",\n \"drinks\",\n \"dinner\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 11,\n \"created_at\": \"2024-11-11T14:45:11.079Z\"\n },\n {\n \"id\": 48,\n \"account_id\": 2,\n \"name\": \"In Room Dining\",\n \"keywords\": [\n \"room service\",\n \"in room dining\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 11,\n \"created_at\": \"2024-11-11T14:45:11.082Z\"\n },\n {\n \"id\": 49,\n \"account_id\": 2,\n \"name\": \"Room\",\n \"keywords\": [\n \"bottled water\",\n \"tea\",\n \"coffee\",\n \"milk\",\n \"cream\",\n \"sugar\",\n \"sweetener\",\n \"minibar\",\n \"mini-bar\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 11,\n \"created_at\": \"2024-11-11T14:45:11.086Z\"\n },\n {\n \"id\": 50,\n \"account_id\": 2,\n \"name\": \"Survey\",\n \"keywords\": [\n \"survey\",\n \"question\",\n \"questionnaire\",\n \"feedback\"\n ],\n \"tag_type\": \"description\",\n \"tag_category_id\": 12,\n \"created_at\": \"2024-11-11T14:45:11.094Z\"\n }\n]"}],"_postman_id":"58c603dc-b3e0-b26b-3943-37bc1b769f76"}],"id":"1d6444f2-16b3-e017-6faf-9f0c373ee65a","description":"

Tags are labels that can be attached to alerts for categorization (e.g. \"Bathroom\", \"HVAC\"). Each tag belongs to a tag_category whose account_id scopes it. Use tag_ids on Create Issue to attach tags during alert creation.

\n","_postman_id":"1d6444f2-16b3-e017-6faf-9f0c373ee65a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"754c78b3-6a94-47f6-9825-34e50966bf24","id":"754c78b3-6a94-47f6-9825-34e50966bf24","name":"WIP Micrometrics API External","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"94463b2c-2c6c-457d-9cee-c933f3439a84","type":"text/javascript","requests":{},"exec":["require('crypto-js');","var url = require('url');","","var timestamp = new Date().toUTCString();","var content_type = request.headers['content-type'];","var key = pm.variables.get('api_key');","var secret = pm.variables.get('api_secret');","","var body = pm.variables.replaceIn(request.data || '');","var content = body.length"," ? CryptoJS.enc.Base64.stringify(CryptoJS.SHA256(body))"," : '';","","var request_params = url.parse(pm.variables.replaceIn(request.url)).search;","var request_path = url.parse(pm.variables.replaceIn(request.url)).pathname","var request_full = request_params ? request_path + request_params : request_path;","","pm.environment.set('httpdate', timestamp);","pm.environment.set('contentSHA256', content);","pm.environment.set(\"request_signature\", get_request_signature());","","function get_request_signature() {"," var req_arr = ["," request.method,"," content_type,"," content,"," request_full,"," timestamp"," ].join(',');"," pm.environment.set('req_arr', req_arr);"," console.log(req_arr);"," var hmac = CryptoJS.HmacSHA1(req_arr, secret);"," return CryptoJS.enc.Base64.stringify(hmac)","}"]}},{"listen":"test","script":{"id":"6eb0ffb9-d94a-44de-b853-2c4d52be5659","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"path","value":""},{"key":"api_key","value":""},{"key":"api_secret","value":""},{"key":"account_id","value":"1"}]}