Skip to content

Using Post ID in Parse.ly Metadata

If you require unique identifier for your posts that is different from the canonical URL, you can use a Post ID in Parse.ly metadata. The Parse.ly Post ID attribute must be unique across all the posts on your site.

One reason you may want this functionality is because you intend to change urls after publication. If that’s the case, note that Parse.ly will continue to display the first URL that we receive in Dash, Reports, API, Recommendations, etc.

Important

When provided, a Post ID will take priority over the Canonical URL value, and we will group your articles by that Post ID instead. However, we discourage using Post ID when possible since grouping articles by Canonical URL is more reliable across Parse.ly’s systems.

JSON-LD format:

The key name for Post ID is articleId and the corresponding value is a string.

Here’s an example of how to include this in the metadata for Parse.ly, using JSON-LD format:

<script type="application/ld+json">
{
  "@context": "http://data-pipeline-schema/.org",
  "@type": "NewsArticle",
  "headline": "Article headline",
  "url": "https://www.example.com/article-url",
  "thumbnailUrl": "https://www.example.com/article-thumbnail",
  "datePublished": "2022-00-00T00:00:00Z",
  "articleSection": "Section Name",
  "creator": ["Author Name"],
  "keywords": ["keyword1", "keyword2"],
  "publisher": {
    "@type": "Organization",
    "name": "Publisher Name",
    "logo": {
      "@type": "ImageObject",
      "url": "https://www.example.com/publisher-logo"
    }
  },
  "articleId": "example-post-id"
}
</script>

Note

The articleId property is not part of the schema.org standard. If you’re concerned about keeping compliance with the standard, you can add it as a repeated meta, as described below, even if you’re otherwise using JSON+LD on your website.

Repeated Metas format:

Here is an example of how to include this in the metadata, using Repeated Metas format:

<meta name="parsely-post-id" content="example-post-id" />

Considerations when using Post ID

Consistency

The Post ID key should remain consistent to avoid duplicate entries and data discrepancies. Changing the Post ID after it has been tracked will cause problems in your analytics data.

Format

It’s very important to ensure that the Post ID doesn’t contain characters that as a result will become future problems, like special characters or white spaces.

Syndication

If you’re interested in Network Syndication, please follow the instructions here. Post ID is not a value that will enable syndication functionality.

Last updated: August 15, 2024