Find Content Items By Tag ID

Returns a list of content items based on tag ID.

Method

/API3/content/findItemsByTag

  • API Section: /API3/content
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

tag

Type

string

Description

The tag ID to search

Output Response

Successful Result Code

200

Response List Type

ItemId[]

Description of Response Type

A generic object used to contain ID of item.. Note that the response is returned as a list of items of this object type.

Notes

Use the 'getAllTags' function to return tags and their ID's for use with this function. For this to be effective, content tags need to be set on items in the content system by users.

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/content/findItemsByTag" \
 -d ''

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ContentServiceApi;

import java.util.*;
import java.time.*;

public class ContentServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentServiceApi apiInstance = new ContentServiceApi();
        // Initialize the tag parameter object for the call
        String tag = tag_example; // Create the input object for the operation, type: String 

        try {
            // "array[ItemId]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[ItemId] result = apiInstance.findItemsByTag(tag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentServiceApi#findItemsByTag");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const opts = {
  'tag': tag_example // {String} 
};

api.findItemsByTag(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class findItemsByTagExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new ContentServiceApi();
        // Initialize the tag parameter object for the call
        var tag = tag_example;  // Create the input object for the operation, type: String |  (optional) 

        try {
            // Returns a list of content items based on tag ID.
            // "array[ItemId]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[ItemId] result = apiInstance.findItemsByTag(tag);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling ContentServiceApi.findItemsByTag: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ContentServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = ContentServiceApi(api_client)
    # Initialize the tag parameter object for the call
    tag = tag_example # String |  (optional)

    try:
        # Returns a list of content items based on tag ID.
        api_response = api_instance.find_items_by_tag(tag=tag)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentServiceApi->findItemsByTag: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
$tag = tag_example; // String | 

try {
    $result = $api_instance->findItemsByTag($tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentServiceApi->findItemsByTag: ', $e->getMessage(), PHP_EOL;
}
?>