api-docs's Issues
Object field reference >> prospect
Add user_id and profile_id as editable fields during prospect update
Typo on Creating Prospects
Reported by Molly:
Under 'Creating Prospects,' should be 'To create a prospect via the API...' instead of propsect.
http://developer.pardot.com/kb/api-version-3/using-prospects#creating-prospects
Object Field References - List fields Incomplete
http://developer.pardot.com/kb/api-version-3/object-field-references#list
is_public and is_crm_visible are missing
Using Lists not complete
http://developer.pardot.com/kb/api-version-3/using-lists
can update, create, and delete via API as well
Sorting Options:
id, created_at, updated_at, name
Valid parameters:
name, title, description, is_public, is_crm_visible
Typos on Object Field References Page
In Opportunity table's description column, 'Opportunity' is spelled incorrectly on several entries:
- name
- type
- stage
Page URL: http://developer.pardot.com/kb/api-version-3/object-field-references/
Screenshot: http://www.screencast.com/t/GZ6MJOsX4Q
Object Field References - Add missing fields
Missing PHP Code Sample
We didn't bring over the code sample that's here: http://developer.pardot.com/kb/code-samples/php-example. (Content can be found here http://webcache.googleusercontent.com/search?sourceid=chrome-psyapi2&ion=1&ie=UTF-8&q=cache%3Ahttp%3A%2F%2Fdeveloper.pardot.com%2Fkb%2Fcode-samples%2Fphp-example&bav=on.2,or.r_qf.&ech=1&psi=EMGBVLCTFoudyASPm4DQBg.1417789713246.3&ei=EMGBVLCTFoudyASPm4DQBg&emsg=NCSR&noj=1)
We should bring this over since clients are asking 'bout it
Querying Visitor Activities Method
There are two required parameters for the visitorActivity method besides 'user_key' and 'api_key' they are 'search_criteria' and 'result_set_criteria'. I can find no references two those parameters that indicate what are considered acceptable values. It would seem that they might be related to the Search Criteria parameters and the Result Set parameters but again there is no actual documentation referring to them.
Add to documentation, listMembership query allows for prospect_id parameter
While documentation doesn't show (unless I'm missing it), you can return list memberships based on a prospect_id (https://pi.pardot.com/api/listMembership/version/3/do/query?prospect_id=####)
Extra Link in API Version 3 -> Introduction & Table of Contents
At the top of the table of contents there's a link "Introduction" that leads nowhere. Should remove it entirely
Emails can only be sent to existing prospects
We should explicitly state that you can only email existing prospects, otherwise send will fail.
Using cURL, I get the following error:
{"@attributes":{"stat":"fail","version":1,"err_code":3},"err":"Invalid prospect ID"}
Object Field References - Visitor fields don't contain info
http://developer.pardot.com/kb/api-version-3/object-field-references#visitor
The following fields don't ever contain any information:
browser
browser_version
operating_system
operating_system_version
language
screen_height
screen_width
is_flash_enabled
is_java_enabled
so maybe should remove from documentation or add note that this information is not filled in
Broken link to visitor activity type
Under 'type' on this page: http://developer.pardot.com/kb/api-version-3/visitor-activities/. If I click on 'Visitor Activity Types' I am brought to this page which is not found: http://developer.pardot.comkb/api-version-3/object-field-references#visitor-activity-types
Add Subheader of where Next and Previous Buttons lead
These buttons will take you the next/previous article listed in the API Version 3 dropdown. Should say which article that is by the button so users know where they're going without having to click on the dropdown
Custom Redirect (use and Query)
can read, query
Sort Options:
id, created_at, updated_at
Search Criteria:
updated_at, created_at, id
Object Field References - Should Include Tag Object Fields
fields include id, tag_id, type, object_id, and created_at
type = type of object associated with the tag
object id = id of object (aka prospect id if type = prospect)
Highlighted box for Left Hand Nav Bar doesn't highlight correct box consistently
sometimes when you click on a link in the nav, we'll highlight a different section, and not the one that was clicked on http://screencast.com/t/EBYjbIncmz
xml invalid in return
running a query for a list results in invalid XML. 2 roots are returned. This worked until 11/11/2015.
https://pi.pardot.com/api/prospect/version/3/do/query?user_key=<user_key>&api_key=<api_key>&list_id=<list_id>&fields=id
Sending List Emails Missing
URL Format for all is missing formatting
Tag (use & Query)
can query and read
Sort Options:
id, created_at, updated_at, name
Query Search Criteria:
id, created_at, updated_at, name
LifeCycle Stage (Use and Query)
can read and query
Sort Options:
id, position
Search Criteria:
id
Campaign (use and query)
can create, read, query, update
Sort Options:
id, created_at, updated_at, name, cost
Search Criteria:
created_at, id, updated_at, name
Valid Parameters:
name, cost
lifecycleStage: read action currently times out
Per https://pardot.atlassian.net/browse/PDT-4153, the "read' action on the lifecycleStage object currently times out. Until that bug is resolved, we should probably leave the "read" action out of the documentation (http://pardot.github.io/api-docs/kb/api-version-3/lifecycle-stages/).
Links to knowledge base are broken
Links to other knowledge-base pages include the "kb/api-version-3" prefix twice and return a 404.
Example: the links in "Also see Campaign in Object Field References" at the top of http://developer.pardot.com/kb/api-version-3/campaigns/
Broken Links to fix
- http://developer.pardot.com/20object-field-references - ref'd from: http://developer.pardot.com/kb/api-version-3/prospects/
- http://developer.pardot.com/authentication - ref'd from: http://developer.pardot.com/kb/api-version-3/error-codes-messages/
- http://developer.pardot.com/kb/api-version-3/error-codes-and-messages - ref'd from: http://developer.pardot.com/kb/api-version-3/prospects/
- http://developer.pardot.com/kb/api-version-3/object-field%20references (note: bad escaped URL) - ref'd from: http://developer.pardot.com/kb/api-version-3/users/ AND http://developer.pardot.com/kb/api-version-3/opportunities/
- http://developer.pardot.com/kb/api-version-3/visitors-activities - ref'd from: http://developer.pardot.com/kb/api-version-3/visitor-activities/ (singular: visitor-, not visitors-)
- http://developer.pardot.com/object-field-references - ref'd from: http://developer.pardot.com/kb/api-version-3/visitor-activities/
- http://developer.pardot.com/using-prospects - ref'd from: http://developer.pardot.com/kb/api-version-3/visitors/ (twice on page) AND http://developer.pardot.com/kb/api-version-3/prospects/ (5x on page)
Add redirects from old pages
Should add a redirect from old links to point to the new ones in case people have them bookmarked
Example links that should be redirected:
http://developer.pardot.com/kb/api-version-3/introduction-table-of-contents
http://developer.pardot.com/kb/api-version-3/querying-prospects
Get Prospects by prospect_id
Hello,
Is there a way to search for prospects by id? For example from a list of visitor activities, I obtain a set of prospect ids. I then would like a way to search for prospects using this set of prospect ids.
Thanks!
Change Solutions team to Support team
The name of the team has changed to Support.
Appears on this page: http://developer.pardot.com/
http://www.screencast.com/t/2FaAuc1q
Access Email Preference Center Link for Pardot Prospect
Is there a way to access a Prospects personal link to the email preference center from the API? We would like to send present this link on our website so users can manage their subscription preferences on Pardot.
Dynamic Content (Use and Query)
can read, query
Sort Options:
id, created_at, updated_at
Search Criteria:
udpated_at, created_at, id
Lifecycle History (Use and Query)
can read, query
Sort Options:
id, created_at
Search Criteria:
id, created_at
Update error codes and messages
Make sure all error codes are listed
Form (Use and Query)
can read, query
Sort Options:
id, created_at, updated_at
Search Criteria:
updated_at, created_at, id
Add info about batch things
Add documentation about
/api/prospect/version/3/do/batchCreate
/api/prospect/version/3/do/batchUpdate
/api/prospect/version/3/do/batchUpsert
Change Link to XML Response Format (for all)
We'll need to change the link to the xml response format in the query section of an object (http://screencast.com/t/g0QMjg12) to point to lower on this same page instead of to the using object's page
Not all pages are in Table of Contents
For example the List Membership one: http://127.0.0.1:8000/kb/api-version-3/querying-list-memberships/ exists on the site, but is not in the table of contents on home page
Object Field References - Should Include Form Fields
id, name, campaign, embedCode, created_at, updated_at
we should do campaign and embedCode similar to how we handle in Prospect http://developer.pardot.com/kb/api-version-3/object-field-references#prospect
Example requests for Assigning & Reassigning Prospects need line breaks
The examples at http://developer.pardot.com/kb/api-version-3/prospects/#assigning-and-reassigning-prospects need some line breaks.
Looks good for narrower windows (http://screencast.com/t/JDp7Y7A9hr), but they display as a bit of a jumble in wider view (http://screencast.com/t/JUchhBSz).
Opted_Out field is Editable for List Memberships
should add an x in the column for editable on list memberships http://developer.pardot.com/kb/api-version-3/object-field-references/#list-membership
Links in API Version 3 -> Introduction & Table of Contents redirect to 404
any of the links in the table of contents redirect to 404s
Update WADL File
I've uploaded a copy of the WADL file we use to power the Apigee API Console (9caa94a).
We need to update this with our new calls in order to update the console itself.
Incorrect Object Field References Link
on this page http://developer.pardot.com/kb/api-version-3/visitor-activities/
the link in this screenshot http://screencast.com/t/letkrPl2 points to http://developer.pardot.comkb/api-version-3/object-field-references#visitor-activity-types instead of http://developer.pardot.com/kb/api-version-3/object-field-references/#visitor-activity-types
A Couple Of Documentation Fixes
From http://developer.pardot.com
Also, keep in mind that all parameters specified in an API request MUST be URL-encoded before they are submitted.
Requests will fail if the API Key, User Key, or Email are URL-encoded
Custom Field (use and query)
can create, read, query, update, delete
Sort Options:
id, created_at, name
Search Criteria:
created_at, id
Valid Parameters:
name, type, crm_id, is_required, is_record_multiple_response, is_use_values
Tag Object (use and query)
can query, read, removed
Sort Options:
id, created_at
Query Search Criteria:
created_at, id, tag_id, type, object_id
Removed Search Criteria:
id, removed_at
Upsert & Update: Undocumented undeletion behavior
When a Prospect for which is_archived=1 has "update" (by email or ID) or "upsert" (by id) run on it, is_archived will stay 1 for the Prospect.
HOWEVER:
When a Prospect for which is_archived=1 has "upsert" (by email) run on it, is_archived will change to 0 for the Prospect.
This needs to be documented for the time being, and a bug/improvement should be filed for it in JIRA to make the behavior consistent across updates/upserts.
Object Field References - Visitor Activities Missing
Need to add the following Visitor Activities types to this list
VIDEO_VIEW = 27;
EVENT_REGISTERED = 28;
EVENT_CHECKEDIN = 29;
VIDEO_CONVERSION = 30;
USERVOICE_SUGGESTION = 31;
USERVOICE_COMMENT = 32;
USERVOICE_TICKET = 33;
VIDEO_WATCHED_THREEQUARTERS = 34;
Authentication article has outdated navigation path
In http://developer.pardot.com/kb/api-version-3/authentication
Step 3 has outdated navigation instructions.
Docs currently say this (italicized part is outdated)
Obtain the email, password, and user_key (available in the application under My Settings) for the Pardot user account that will be submitting API requests.
Suggested change in italics below:
Obtain the email, password, and user_key (available in Pardot by navigating to {your email address} > Settings > Scroll to API User Key row) for the Pardot user account that will be submitting API requests.
Add Search Bar (?)
we used to have a search bar on old API docs... should we add that for this one as well? It looks like menu is good enough that users will be able to find what they want, but do we think we should also add in capability to search?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.