Search the Omeda Knowledge Base
-
The Omeda Experience
-
Documentation
-
-
- Brand Comprehensive Lookup Service
- Brand Promotions Quantity
- Brand Group Lookup
- Brand Promotions Content By Promo Code
- Brand Promotions By Promo Code
- Behavior Categories Lookup
- Behavior Actions Lookup
- Behavior Lookup Grouped By Product
- Behavior Lookup By Id
- Behavior Lookup
- Demographic Lookup by Brand API
- Deployment Type Lookup by Brand API
- Product Lookup by Brand API
-
- Customer Lookup By Email Address
- Subscription Lookup By Customer Id
- Order History Lookup by Customer Id
- Customer Lookup by Hashed Email Address
- Email Address Lookup By Customer Id
- Gift Lookup by Donor ID
- Behavior Lookup By Customer Id
- Subscription Lookup By Email
- Customer Merge History Lookup
- Customer Lookup By Name and Country
- External ID Lookup By Customer Id
- Demographic Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By PostalAddressId
- Customer Lookup By Customer Id
- Email Validity Lookup API
- Show all articles ( 6 ) Collapse Articles
-
- Email On Demand Send
- Email Deployment
- Email Deployment Clone
- Email Deployment Remove Audience
- Email Audience Assignment Status
- Email Deployment Content
- Email Deployment Approval Lookup
- Email Deployment Schedule
- Email Deployment Cancel
- Email Deployment Search
- Email Flag Email As Invalid
- Email Clicks
- Email - Checklist for Sends Created via API Calls
- Email Deployment Content Lookup
- Email Deployment Unschedule
- Email Deployment Lookup
- Email Deployment Test
- Email Deployment Add Audience
- Email Opt In/Out Lookup
- Email Optout Queue
- Email Optin Queue
- Email Deployment Audience List FTP
- Show all articles ( 7 ) Collapse Articles
-
-
- Release Notes for Jan 27 | V23.2
- Release Notes for Feb 17 | V23.3
- Release Notes for Mar 10 | V23.4
- Release Notes for Mar 31 | V23.5
- Release Notes for Apr 21 | V23.6
- Release Notes for May 19 | V23.7
- Release Notes for June 2 | V23.8
- Release Notes for June 23 | V23.9
- Release Notes for July 14 | V23.10
- Release Notes for Aug 4 | V23.11
- Release Notes for Aug 25 | V23.12
- Release Notes for Sep 15 | V23.13
-
- Release Notes for Jan 14 | V22.1
- Release Notes for Feb 4 | V22.2
- Release Notes for Feb 25 | V22.3
- Release Notes for Mar 18 | V22.4
- Release Notes for Apr 8 | V22.5
- Release Notes for Apr 29 | V22.6
- Release Notes for May 20 | V22.7
- Release Notes for June 10 | V22.8
- Release Notes for July 1 | V22.9
- Release Notes for July 22 | V22.10
- Release notes for Aug 12 | V22.11
- Release Notes for Sep 2 | V22.12
- Release Notes for Sep 23 | V22.13
- Release Notes for Oct 14 | V22.14
- Release Notes for Nov 4 | V22.15
- Release Notes for Dec 2 | V22.16
- Show all articles ( 1 ) Collapse Articles
-
- Release Notes for V21.1
- Release Notes for V21.2
- Release Notes for V21.3
- Release Notes for V21.4
- Release Notes for V21.5
- Release Notes for V21.6
- Release Notes for V21.7
- Release Notes for V21.8
- Release Notes for V21.9
- Release Notes for V21.10
- Release Notes for V21.11
- Release Notes for V21.12
- Release Notes for V21.13
- Release Notes for V21.14
- Release Notes for V21.15
- Release Notes for V21.16
- Release Notes for V21.17
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V20.1
- Release Notes for V20.2
- Release Notes for V20.3
- Release Notes for V20.4
- Release Notes for V20.5
- Release Notes for V20.6
- Release Notes for V20.7
- Release Notes for V20.8
- Release Notes for V20.9
- Release Notes for V20.10
- Release Notes for V20.11
- Release Notes for V20.12
- Release Notes for V20.13
- Release Notes for V20.14
- Release Notes for V20.15
- Release Notes for V20.16
- Release Notes for V20.17
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V19.1
- Release Notes for V19.2
- Release Notes for V19.3
- Release Notes for V19.4
- Release Notes for V19.5
- Release Notes for V19.6
- Release Notes for V19.7
- Release Notes for V19.8
- Release Notes for V19.9
- Release Notes for V19.10
- Release Notes for V19.11
- Release Notes for V19.12
- Release Notes for V19.13
- Release Notes for V19.14
- Release Notes for V19.15
- Release Notes for V19.16
- Release Notes for V19.17
- Show all articles ( 2 ) Collapse Articles
-
-
-
CDP – Customer Data Platform
-
-
- Personalization Overview
- Personalization - FAQs
- Personalization - Reporting
- Personalization - Archiving & Restoring
- Personalization - HTML Templates
- Personalization - Scroll Trigger and Infinite Scroll Pages
- Personalization - Merge Variables
- Personalization - 'Generate Personalization' Option
- Personalization & Metering - Click Tracking
- GDPR Consent Management
- Form Builder - Embedding Webforms via iFrame or Javascript
-
-
Integrations
-
-
- Integration with Zapier
- Bring Customer Data in via Webhooks by Zapier Action - POST Event
- Bring Customer Data in using Zapier
- Omeda's Add Customer Action in Zapier
- Send Form Submission Data via Zapier
- Bring Customer Data in via Webhooks by Zapier Action – Custom Request Event
- Formatter by Zapier Action
-
-
-
Analytics & Reporting
-
- Odyssey - Reporting
- Personalization - Reporting
- Reports - Email Device and Client Type Reporting
- Email - Clickbot Reporting
- Reports - Email Reporting
- Metering - Reporting
- Reports - Audience Overlap Report
- Reports - Engaged Companies Report
- Reports-AutoRenewals Analysis Report
- Reports - Audience Report
- Reports - Issue Activity Reporting
- Reports - Overview
- Reports - Web Behavior Reporting
- Reports- FAQs
- Reports - Data Tracker Reporting
- Reports - Audience Builder (OnQ) Reporting
- Form Submit Report
- Behavior Promo Code Report
- Reporting Library
- Show all articles ( 4 ) Collapse Articles
-
Marketing Automation & Email Builder
-
-
- Email On Demand Send
- Email Deployment
- Email Deployment Clone
- Email Deployment Remove Audience
- Email Audience Assignment Status
- Email Deployment Content
- Email Deployment Approval Lookup
- Email Deployment Schedule
- Email Deployment Cancel
- Email Deployment Search
- Email Flag Email As Invalid
- Email Clicks
- Email - Checklist for Sends Created via API Calls
- Email Deployment Lookup
- Email Deployment Test
- Email Deployment Add Audience
- Email Opt In/Out Lookup
- Email Optout Queue
- Email Optin Queue
- Email Deployment Audience List FTP
- Show all articles ( 5 ) Collapse Articles
- Email Builder - User Guide
- Email - Clickbot Reporting
- Reports - Email Reporting
- Email - Link Tracking Errors
- Email - Deployment Defaults
- Omeda - Getting Support
- Email - Checklist for Sends Created via API Calls
- Email - Assigning Link Tracking Categories
- Email - Deliverability
- Email - Opt-Out Footer Merge Variable
- Email - Stealth Link
- Email - Behavioral Data
- Email - Automation for Email Sending
- Email - Checklist for New Clients
- Email - Deployment Type Creation
- Email – Training Schedules for New Clients
- Email - Request a New Deployment Type
- Email - Adding Domains to Safe Sender List
- Email - Deployment Checklist & Best Practices
- Email Deployment Unschedule
- Email Builder - Getting Started
- Campaign App - Overview
- Email - Automated ACS Notifications
- Email - Dynamic Content
- Email - Recurring Deployments
- Email - FAQs
- Email - Web Tracking
- Email - Validation Services
- Email Services - Overview & Capabilities
- Email - Web Tracking String Parameter Definitions
- Email - Appending Lists On Triggered Deployments
- Email - Preference Page
- Email - A/B Testing
- Email - Triggered Deployments
- Email - Merge Variables
- Email - User Set-up
- Email - Advanced Features
- Email - Glossary
- Show all articles ( 23 ) Collapse Articles
-
-
-
- Odyssey - Audience Element
- Odyssey - Timing Elements
- Odyssey - Adroll Elements
- Odyssey - Facebook Elements
- Odyssey - Filter Element
- Odyssey - Form Submit Element
- Odyssey - Pathfinder Element
- Odyssey - Export Element
- Odyssey - Split Element
- Odyssey - Personalization Element
- Odyssey - Metering Element
- Odyssey - Email Element
- Odyssey - Goal Element
- Odyssey - A/B Test Element
- Odyssey - Google Ad Manager Element
- Odyssey Fatigue Filter Element
- Show all articles ( 1 ) Collapse Articles
- Odyssey Overview
- Odyssey - FAQs
- Odyssey - Editing an In Progress Voyage
- Odyssey - Reporting
- Odyssey - Querying Element Visitors in Audience Builder
- Odyssey - Using Profiles
- Odyssey - Creating Custom Templates
- Odyssey - Global Settings
- Odyssey - Email Conditions
- Odyssey - Omeda's Email Designer
- Odyssey - Email Designer Templates
- Odyssey - Voyage Templates
- Odyssey - Merging Paths
- Odyssey - Email Merge Variables
- Odyssey - Error Troubleshooting
- Odyssey - Dynamic Content
- Show all articles ( 1 ) Collapse Articles
-
-
-
Data Management & Governance
-
- Odyssey - Querying Element Visitors in Audience Builder
- Audience Builder - Product Field Library
- Examples of Audience Builder Queries Using Paid Fields
- Querying Olytics Your Olytics Data
- Data Loader - Querying in Audience Builder
- Email - Behavioral Data
- Audience Builder (OnQ) - Date Field Definitions
- Audience Builder (OnQ) - How To Query Customers
- Audience Builder (OnQ) - Query Result Outputs
- Audience Builder (OnQ) - Overview
- Reports - Audience Builder (OnQ) Reporting
- Audience Builder (OnQ) - Admin User Guide
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - Match Evaluation
-
-
Subscription & Fulfillment Management
-
Forms & Landing Pages
-
- Form Builder (Dragon) - Overview
- How To Use Progressive Profiling
- Using a Custom Domain for your Dragon Webform
- Dragon Forms URL Structure and Appending Parameters
- Best Practices for Testing Forms
- Test Links v. Live Links
- Styling Your Dragon Webforms
- CredSpark - Omeda Form Listener Integration
- Using Dragon Form Builder to capture a Behavior Subscription Attribute
- Form Builder ADA Compliance
- Form Builder (Dragon) Themes
- 2020 Form Builder Updates
- Form Builder - Using Campaign Promo Codes
- Form Builder - Using the PayPal Payment Method
- Form Builder - Embedding Webforms via iFrame or Javascript
-
- How To Use A/B Testing on your Dragon Webform (video)
- How to conditionally display a question on your form (video)
- How to create and add an email confirmation to your form (video)
- How to update a demographic (video)
- How to send a user back to your website after form submission (redirect to a return URL)
- Form Builder - Export URL
- Form Builder - Adding a This Is Not Me Widget
- Form Builder - Embedding Webforms via iFrame or Javascript
-
-
Success Use Cases
-
Professional Services
-
Video Library
-
FAQs
Demographic Lookup By Customer Id
Summary
This service returns all available customer demographics stored for a given customer by using the Customer ID.
General Technical Requirements
The following technical requirements apply to all requests for this API.
Base Resource URI
Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/demographic/* Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/demographic/*
brandAbbreviation is the abbreviation for the brand customerId is the internal customer id (encrypted customer id may also be used)
HTTP Headers
The HTTP header must contain the following element: x-omeda-appid a unique id provided to you by Omeda to access your data. The request will fail without a valid id.
Content Type
The content type is application/json. JSON application/json
JSON is the preferred data exchange format, because it is lightweight and, in most cases, faster to process and utilizes less bandwidth. There are many available open-source JSON libraries available. See json.org for details.
Supported HTTP Methods
There is one HTTP method supported:
- GET : See W3C’s GET specs for details.
Lookup Demograhics By Customer Id
Retrieves a record containing all demographic information about the customer.
Field Definition
The following tables describe the hierarchical data elements.
In addition to the below elements, a SubmissionId element will also be returned with all responses. This is a unique identifier for the web services response. It can be used to cross-reference the response in Omeda’s database.
CustomerDemographics Elements
Element Name | Description |
---|---|
Customer | Element containing an http reference to the owning customer resource. |
CustomerDemographic | each CustomerDemographic element contains all demographic information. |
CustomerDemographic Elements
Element Name | Always Returned… | Data type | Description |
---|---|---|---|
Id | No | unique customer demographic identifier | |
DemographicId | No | integer that defines the demographic the responses are gathered for | |
DemographicType | No | integer – see Additional Information for the list of values and their descriptions | |
DemographicAge | No | integer – The number of years since the demographic was collected for this customer. The “year” is calculated based on the product’s audit cycle. | |
ValueId | Yes | the individual response value, if the response/data was for a single-response or a multiple-response demographic. | |
ValueText | Yes | the individual response value, if the response/data was for a text-response demographic. | |
ValueDate | Yes | the individual response value, if the response/data was for a date-response demographic. | |
WriteInDesc | Yes | String | If the Demographics Value “Type” is an “Other” response, and a text answer is being stored for this “Other” value, then the text answer will be returned. |
AlternateId | No | String | An id that can be used to uniquely identify this demographic(perhaps in your content management system). |
ChangedDate | no | Date & time record last changed. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34. |
Response
HTTP Response Codes
Status | Description |
---|---|
200 OK | The request has succeeded. See Example Response below. |
403 Forbidden | Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid. |
404 Not Found | Typically, this error occurs with a malformed URL or the resource that is searched for is not found. |
500 Internal Server Error | In the rare case that there is a server-side problem, this response will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable. Please contact your Omeda Account Representative if the issue continues. |
Success
{ "Customer":"https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/*", "CustomerDemographics":[ { "Id":4201512, "DemographicId":100, "DemographicType":1, "ValueId":192, "ChangedDate": "2015-03-08 21:23:34" }, { "Id":4201513, "DemographicId":101, "DemographicType":3, "ValueText":"Turquoise", "ChangedDate": "2015-03-08 21:23:34" }, { "Id":4201514, "DemographicId":114, "DemographicType":1, "ValueId":196, "ChangedDate": "2015-03-08 21:23:34" }, { "Id":4201515, "DemographicId":115, "DemographicType":2, "ValueId":197, "ChangedDate": "2015-03-08 21:23:34" }, { "Id":4201516, "DemographicId":115, "DemographicType":1, "WriteInDesc":"write in text", "ChangedDate": "2015-03-08 21:23:34" }, { "Id":4201517, "DemographicId":116, "DemographicType":6, "ValueDate":"2015-04-19 11:33:17", "ChangedDate": "2015-03-08 21:23:34" } ] "SubmissionId" : "24B9BF6F-0677-462B-942A-D87EEBD10F77" }
Failure
{ "SubmissionId":"ec0c2ba6-13f4-4934-8efa-74c2ccb33f1d", "Errors":[ { "Error":"No demographics found for customer 12345." } ] }
Possible Error Messages
In the event of an error, an error response will be returned. Here are some of the possible responses you might receive.
No demographics found for customer {customerId}.
Additional Information
Demographics – DemographicType
StatusCode | Description |
---|---|
1 | a single-choice-allowed type of question. (Two or more choices – one answers) |
2 | a multiple-choice-allowed type of question. (Two or more choices – many answers) |
3 | an open-form short answer question. (No choices – text input) |
5 | a yes/no answer |
6 | a date answer |
7 | a whole number answer |
8 | a decimal answer |