API Reference | UserEvidence Help Center

API URLs

Production	https://app.userevidence.com
Staging	https://app.userevidence.mobi

Authentication

Please obtain your API key from your account representative. We expect your API key to be passed in as a bearer token using an Authorization header.

Authorization: Bearer <YOUR API KEY HERE>

Content Assets

Index

GET /api/integrations/content_assets.json

(Returns an array of content assets)

Parameters

Term	Description	Default
q	term to search for
per	amount per page	25
page	the page of 'per' to fetch	1
sort	sort direction ‘asc’ or ‘desc’	asc
sector_id	sector to filter on
size_group	size group to filter on
seniority	seniority to filter on
recipient_role_id	role to filter on
survey_id	survey to filter on
tags	comma separated list of tags to filter on

Show

GET /api/integrations/content_assets/(:id).json

(Returns a single content asset)

Data Shape for Both Endpoints

Name	Type
id	integer
identifier	string
title	string
the_text	string
research_library_page_url	string
created_at	datetime
updated_at	datetime
filtered_by	string
tag	string

Filters

GET /api/integrations/content_assets/filters.json

(Returns content asset filters)

Sample Response:

=> {"size_group_filters"=>[{"id"=>"small_business", "name"=>"1-50", "count"=>1}],
 "sector_filters"=>[{"id"=>895, "name"=>"Computer & Network Security", "count"=>1}],
 "seniority_filters"=>[{"id"=>"individual_contriubutor", "name"=>"Individual Contributor/Specialist/Associate", "count"=>1}],
 "recipient_role_filters"=>[{"id"=>588, "name"=>"attorney at law", "count"=>1}],
 "tag_filters"=>[]}

Create

POST /api/integrations/content_assets.json

(Create a new content asset. Currently only testimonials are supported.)

Name	Type	Description
`renderable_type`	`string`	Must always be `“Testimonial”`
`title`	`string`	The title of the asset
`show_title`	`boolean`	Whether or not to show the title on the rendered asset
`renderable_attributes`	`object`	These are the specific attributes for the renderable type you’re creating. Currently only Testimonials are supported. See the table below for the allowed Testimonial attributes.
`tag_list`	`string`	comma-separated list of tags for the new asset

Testimonial Attributes

Name	Type	Description
`source`	`string`	The source of the testimonial
`text`	`string`	The actual testimonial text
`author_name`	`string`
`author_title`	`string`
`author_company`	`string`
`nps_score`	`integer`	The NPS score (1-10)
`email`	`string`	The email address of the testimonial author
`show_nps`	`boolean`	Whether or not to show the NPS score on the testimonial
`show_question`	`boolean`	Whether or not to show the question on the testimonial
`public`	`boolean`	Determines if the testimonial is public or not

Response

Codes

200 - Asset was created successfully
422 - Asset was not created successfully
500 - we messed up

Success Attributes

Name	Type	Description
`id`	`integer`	The internal ID of the asset
`identifer`	`string`	The asset’s UE Identifier, used to reference it in a URL.
`title`	`string`	The title of the asset
`show_title`	`boolean`	Whether or not to show the title.
`renderable`	`object`	The attributes of the renderable created. See “Testimonial attributes” above.

Recipients

Index

GET /api/integrations/recipients.json

(Returns an array of recipients)

Term	Description	Default
per	amount per page	25
page	the page of 'per' to fetch	1
sort	sort direction ‘asc’ or ‘desc’	asc
responded	return only recipients that have responded to a survey question	false
`survey_name`	Return only recipients that are part of a survey named `survey_name`	`nil`

Create

POST /api/integrations/recipients.json

Parameters

Term	Description
`survey_id` (required)	Required - The survey id to attach the recipient to
`email` (required)	Required - the email address of the recipient
`first_name`	Recipient’s first name
`last_name`	Recipient’s last name
`company_name`	Supply an optional company name which will be used during clearbit enrichment. Not required for Clearbit enrichment.

Show

GET /api/integrations/recipients/(:id).json

(Returns a single recipient)

Parameters

Term	Description
id	UserEvidence unique identifier

Data Shape for Both Endpoints

Name	Type
id	integer
first_name	string
last_name	string
email	string
nps_score	integer
responded	boolean
submitted_assset_count	integer
updated_at	datetime
survey_url	string

Accounts

Filters

GET /api/integrations/accounts/filters.json

(Returns content asset filters for the account)

UserEvidence for Gong Integration

How to Embed Assets