Getting search results from an user session

Getting search results from an user session

When you call Public endpoints such as the Search endpoint, it will return results from a random unauthenticated session.

If you want to get more uniform results and tailored for a specific user, it is possible to call the endpoint from an user scope by including the X-Account-Key.

Example in Python:
  1. from tikapi import TikAPI

  3. api = TikAPI("yourAPIKey")

  5. api.set(
  6. __options__={
  7. 'params':{
  8. 'accountKey':{
  9. 'name': 'X-Account-Key',
  10. 'help': "The Account Key is invalid.",
  11. 'location': "headers",
  12. 'validate': "^[a-zA-Z0-9]{10,}$"
  13. }
  14. }
  15. }
  16. )

  18. # Just add the  accountKey parameter
  19. api.public.search("autocomplete", "query", accountKey="myOptionalAccountKeyHere")
Example in Javascript:
  1. import TikAPI from 'tikapi';

  3. api = TikAPI("yourAPIKey")

  5. api.set(
  6. $options: {
  7. params:{
  8. accountKey:{
  9. name: 'X-Account-Key',
  10. help: "The Account Key is invalid.",
  11. location: "headers",
  12. validate: "^[a-zA-Z0-9]{10,}$"
  13. }
  14. }
  15. }
  16. )

  18. api.public.search({
  19. category: "autocomplete", 
  20. query: "query", 
  21. accountKey: "myOptionalAccountKeyHere"
  22. })