added release notes #100

joeyrivera · 2017-03-16T20:28:24Z

No description provided.

juan-nunez · 2017-03-16T20:41:04Z

docs/kb/release-notes.md

+
+### Visitor Activities 
+
+A few updates where made to the `query` endpoint for both version 3 and 4. These include:


were instead of where

juan-nunez · 2017-03-16T22:33:45Z

👍

the-melonhead · 2017-03-16T23:19:36Z

docs/kb/release-notes.md

@@ -0,0 +1,29 @@
+# Release Notes
+
+Here you'll find the latest updates on what's changed in the Pardot API and API documentation.


This title contains several contractions and slang. Best to avoid such in tech writing.
Perhaps "This page contains the release notes for the Pardot API and related documentation."

the-melonhead · 2017-03-16T23:26:23Z

docs/kb/release-notes.md

+
+### Visitor Activities 
+
+A few updates were made to the `query` endpoint for both version 3 and 4. These include:


No need for flourishing with superfluous 'a few updates' or 'these include. EX:

'query' end-point (v3-4):

blah

blah

also, use end-point or end point (Endpoint is a specific name for several companies, band names, etc.)

the-melonhead · 2017-03-16T23:27:07Z

docs/kb/release-notes.md

+
+A few updates were made to the `query` endpoint for both version 3 and 4. These include:
+
+* any email activity that is part of an email list will now include the list_email_id


'related to' instead of 'is a part of'

the-melonhead · 2017-03-16T23:29:10Z

docs/kb/release-notes.md

+A few updates were made to the `query` endpoint for both version 3 and 4. These include:
+
+* any email activity that is part of an email list will now include the list_email_id
+* any email activity that belongs to an email which used an email template, will include the email_template_id


'related to' instead of 'belongs to'
'generated from' instead of 'which used'

the-melonhead · 2017-03-16T23:33:11Z

docs/index.md

@@ -77,6 +78,7 @@ The Pardot API supports several output formats, each of which returns different
 *   `full` -- Returns all supported data for the Pardot object and all objects associated with it.
 *   `simple` -- Returns all supported data for the data for the Pardot object.
 *   `mobile` -- Returns an abbreviated version of the object data. This output format is ideal for mobile applications.
+*   `bulk` -- Returns basic data for an object without a total object count. Used for querying [large amounts of data](kb/bulk-data-pull/). 


I would recommend using parenthesis '(does not provide total object count)'.

the-melonhead · 2017-03-16T23:35:06Z

docs/index.md

@@ -5,6 +5,7 @@ Welcome! All up-to-date documentation of Pardot's official API is housed here. A
 * If you have a question about the API, feel free to [open a ticket](https://pardot.desk.com/) with our Support team.
 * To report an inconsistency in the documentation, please [open an issue on GitHub](https://github.com/Pardot/api-docs/issues). [Pull requests](https://github.com/Pardot/api-docs/pulls) are welcome as well!
 * If you've written your own library or wrapper for Pardot's API, submit a [pull request](https://github.com/Pardot/api-docs/pulls) updating the `index.md` file with a link to your repository, and we'll be glad to consider linking it up.
+* If you want to see what's changed recently in the API or the documentation, please go visit the [Release Notes](kb/release-notes).


Several slang phrases here. Suggest:
For the latest information on updates to the API and related documentation, refer to the [Release Notes]

the-melonhead · 2017-03-16T23:41:45Z

docs/kb/release-notes.md

+
+* any email activity that is part of an email list will now include the list_email_id
+* any email activity that belongs to an email which used an email template, will include the email_template_id
+* new filters are available to query visitor activities by [object type](api-version-4/visitor-activities/#supported-search-criteria):


[filter visitor activities by various object types]

the-melonhead · 2017-03-16T23:44:24Z

docs/kb/release-notes.md

+
+#### Email
+
+* when using the `read` endpoint, you can now remove the email text and html body message from the response by setting [include_message](api-version-4/emails/#supported-parameters) to false.


end-point (not endpoint)
HTML (not html)
'you can exclude' instead of 'you can now remove'

the-melonhead · 2017-03-17T00:13:46Z

docs/kb/release-notes.md

+
+#### Other
+
+In the documents under the "Manipulating the Result Set" section for many of the objects, it was identified the `sort_by` 


Mentions of default value: 'id' for the 'sort_by' query parameter have been removed from API documentation for clarity

I wonder if it's still worth mentioning what the issue was or at least make sure to let the user know to set this. Thoughts?

added release notes

2145778

juan-nunez reviewed Mar 16, 2017

View reviewed changes

cr fix

3598c41

the-melonhead reviewed Mar 16, 2017

View reviewed changes

the-melonhead reviewed Mar 17, 2017

View reviewed changes

joeyrivera added 3 commits March 17, 2017 11:44

edits based on cr

7300cf4

quick fix to formating

9bbe338

cr fix

2c56f17

joeyrivera merged commit fd55138 into master Mar 17, 2017

franciscosanchezsfdc deleted the jr/W-3756786 branch June 11, 2020 15:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added release notes #100

added release notes #100

joeyrivera commented Mar 16, 2017

juan-nunez Mar 16, 2017

juan-nunez commented Mar 16, 2017

the-melonhead Mar 16, 2017

the-melonhead Mar 16, 2017 •

edited

the-melonhead Mar 16, 2017 •

edited

the-melonhead Mar 16, 2017 •

edited

the-melonhead Mar 16, 2017

the-melonhead Mar 16, 2017

the-melonhead Mar 16, 2017

the-melonhead Mar 16, 2017

the-melonhead Mar 17, 2017

joeyrivera Mar 17, 2017


		### Visitor Activities

		A few updates where made to the `query` endpoint for both version 3 and 4. These include:

		@@ -0,0 +1,29 @@
		# Release Notes

		Here you'll find the latest updates on what's changed in the Pardot API and API documentation.


		### Visitor Activities

		A few updates were made to the `query` endpoint for both version 3 and 4. These include:


		A few updates were made to the `query` endpoint for both version 3 and 4. These include:

		* any email activity that is part of an email list will now include the list_email_id


		#### Email

		* when using the `read` endpoint, you can now remove the email text and html body message from the response by setting [include_message](api-version-4/emails/#supported-parameters) to false.


		#### Other

		In the documents under the "Manipulating the Result Set" section for many of the objects, it was identified the `sort_by`

added release notes #100

added release notes #100

Conversation

joeyrivera commented Mar 16, 2017

Choose a reason for hiding this comment

juan-nunez commented Mar 16, 2017

Choose a reason for hiding this comment

the-melonhead Mar 16, 2017 • edited

Choose a reason for hiding this comment

'query' end-point (v3-4):

the-melonhead Mar 16, 2017 • edited

Choose a reason for hiding this comment

the-melonhead Mar 16, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

the-melonhead Mar 16, 2017 •

edited

the-melonhead Mar 16, 2017 •

edited

the-melonhead Mar 16, 2017 •

edited