Keyword Filter

Create Keyword Filtering List

Request Sample

const result = await mediaviz.keywords.createKeywordFilteringList('<NAME>', '<PROJECT_LIST>');

import type { KeywordListDisplayWithProjects } from '@mediaviz/sdk';

const result: KeywordListDisplayWithProjects = await mediaviz.keywords.createKeywordFilteringList('<NAME>', '<PROJECT_LIST>');

const result = await mediaviz.keywords.createKeywordFilteringList('<NAME>', '<PROJECT_LIST>');

result = mediaviz.keywords.create_keyword_filtering_list('<NAME>', '<PROJECT_LIST>')

$result = $mediaviz->keywords->createKeywordFilteringList('<NAME>', '<PROJECT_LIST>');

curl -X POST 'https://api.mediaviz.ai/api/v1/keyword/' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "<NAME>",
  "project_list": "<PROJECT_LIST>"
}
JSON

Get User Keyword Filtering Lists

Request Sample

const result = await mediaviz.keywords.getUserKeywordFilteringLists();

import type { KeywordListDisplayWithProjects } from '@mediaviz/sdk';

const result: KeywordListDisplayWithProjects[] = await mediaviz.keywords.getUserKeywordFilteringLists();

const result = await mediaviz.keywords.getUserKeywordFilteringLists();

result = mediaviz.keywords.get_user_keyword_filtering_lists()

$result = $mediaviz->keywords->getUserKeywordFilteringLists();

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/user' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Company Keyword Lists

Request Sample

const result = await mediaviz.keywords.getCompanyKeywordLists('<COMPANY_ID>');

import type { CompanyKeywordListOverview } from '@mediaviz/sdk';

const result: CompanyKeywordListOverview[] = await mediaviz.keywords.getCompanyKeywordLists('<COMPANY_ID>');

const result = await mediaviz.keywords.getCompanyKeywordLists('<COMPANY_ID>');

result = mediaviz.keywords.get_company_keyword_lists('<COMPANY_ID>')

$result = $mediaviz->keywords->getCompanyKeywordLists('<COMPANY_ID>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/company/<COMPANY_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Keyword Filtering List And Projects By Id

Request Sample

const result = await mediaviz.keywords.getKeywordFilteringListAndProjectsById('<KEYWORD_LIST_ID>');

import type { KeywordListDisplayWithProjects } from '@mediaviz/sdk';

const result: KeywordListDisplayWithProjects = await mediaviz.keywords.getKeywordFilteringListAndProjectsById('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.getKeywordFilteringListAndProjectsById('<KEYWORD_LIST_ID>');

result = mediaviz.keywords.get_keyword_filtering_list_and_projects_by_id('<KEYWORD_LIST_ID>')

$result = $mediaviz->keywords->getKeywordFilteringListAndProjectsById('<KEYWORD_LIST_ID>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Keyword Filtering List By Id

Request Sample

const result = await mediaviz.keywords.getKeywordFilteringListById('<KEYWORD_LIST_ID>');

import type { KeywordListDisplayWithList } from '@mediaviz/sdk';

const result: KeywordListDisplayWithList = await mediaviz.keywords.getKeywordFilteringListById('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.getKeywordFilteringListById('<KEYWORD_LIST_ID>');

result = mediaviz.keywords.get_keyword_filtering_list_by_id('<KEYWORD_LIST_ID>')

$result = $mediaviz->keywords->getKeywordFilteringListById('<KEYWORD_LIST_ID>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/list/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Existing Keyword Filtering List By Project

Request Sample

const result = await mediaviz.keywords.getExistingKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

const result = await mediaviz.keywords.getExistingKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

const result = await mediaviz.keywords.getExistingKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

result = mediaviz.keywords.get_existing_keyword_filtering_list_by_project('<PROJECT_TABLE_NAME>')

$result = $mediaviz->keywords->getExistingKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/project/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Default Keyword Filtering List By Project

Request Sample

const result = await mediaviz.keywords.getDefaultKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

const result = await mediaviz.keywords.getDefaultKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

const result = await mediaviz.keywords.getDefaultKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

result = mediaviz.keywords.get_default_keyword_filtering_list_by_project('<PROJECT_TABLE_NAME>')

$result = $mediaviz->keywords->getDefaultKeywordFilteringListByProject('<PROJECT_TABLE_NAME>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/project/<PROJECT_TABLE_NAME>/default' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Update Keyword Filtering List Labels

Request Sample

const result = await mediaviz.keywords.updateKeywordFilteringListLabels(
  '<KEYWORD_LIST_ID>',
  '<LIST_KEYWORDS_TO_INCLUDE>',
  '<LIST_KEYWORDS_TO_EXCLUDE>'
);

import type { KeywordListDisplayWithList } from '@mediaviz/sdk';

const result: KeywordListDisplayWithList = await mediaviz.keywords.updateKeywordFilteringListLabels(
  '<KEYWORD_LIST_ID>',
  '<LIST_KEYWORDS_TO_INCLUDE>',
  '<LIST_KEYWORDS_TO_EXCLUDE>'
);

const result = await mediaviz.keywords.updateKeywordFilteringListLabels(
  '<KEYWORD_LIST_ID>',
  '<LIST_KEYWORDS_TO_INCLUDE>',
  '<LIST_KEYWORDS_TO_EXCLUDE>'
);

result = mediaviz.keywords.update_keyword_filtering_list_labels(
    '<KEYWORD_LIST_ID>',
    '<LIST_KEYWORDS_TO_INCLUDE>',
    '<LIST_KEYWORDS_TO_EXCLUDE>'
)

$result = $mediaviz->keywords->updateKeywordFilteringListLabels(
  '<KEYWORD_LIST_ID>',
  '<LIST_KEYWORDS_TO_INCLUDE>',
  '<LIST_KEYWORDS_TO_EXCLUDE>'
);

curl -X PUT 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "list_keywords_to_include": "<LIST_KEYWORDS_TO_INCLUDE>",
  "list_keywords_to_exclude": "<LIST_KEYWORDS_TO_EXCLUDE>"
}
JSON

Update Keyword Filtering List Details

Request Sample

const result = await mediaviz.keywords.updateKeywordFilteringListDetails(
  '<KEYWORD_LIST_ID>',
  {
    name: '<NAME>',
    projectList: '<PROJECT_LIST>'
  }
);

import type { KeywordListDisplayWithProjects } from '@mediaviz/sdk';

const result: KeywordListDisplayWithProjects = await mediaviz.keywords.updateKeywordFilteringListDetails(
  '<KEYWORD_LIST_ID>',
  {
    name: '<NAME>',
    projectList: '<PROJECT_LIST>'
  }
);

const result = await mediaviz.keywords.updateKeywordFilteringListDetails(
  '<KEYWORD_LIST_ID>',
  {
    name: '<NAME>',
    projectList: '<PROJECT_LIST>'
  }
);

result = mediaviz.keywords.update_keyword_filtering_list_details(
    '<KEYWORD_LIST_ID>',
    name='<NAME>',
    project_list='<PROJECT_LIST>'
)

$result = $mediaviz->keywords->updateKeywordFilteringListDetails(
  '<KEYWORD_LIST_ID>',
  [
    'name' => '<NAME>',
    'projectList' => '<PROJECT_LIST>'
  ]
);

curl -X PUT 'https://api.mediaviz.ai/api/v1/keyword/details/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "<NAME>",
  "project_list": "<PROJECT_LIST>"
}
JSON

Add Projects To Keyword Filtering List

Request Sample

const result = await mediaviz.keywords.addProjectsToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    projectIds: '<PROJECT_IDS>'
  }
);

const result = await mediaviz.keywords.addProjectsToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    projectIds: '<PROJECT_IDS>'
  }
);

const result = await mediaviz.keywords.addProjectsToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    projectIds: '<PROJECT_IDS>'
  }
);

result = mediaviz.keywords.add_projects_to_keyword_filtering_list('<KEYWORD_LIST_ID>', project_ids='<PROJECT_IDS>')

$result = $mediaviz->keywords->addProjectsToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  [
    'projectIds' => '<PROJECT_IDS>'
  ]
);

curl -X POST 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>/projects' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Add Company To Keyword Filtering List

Request Sample

const result = await mediaviz.keywords.addCompanyToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    companyId: '<COMPANY_ID>'
  }
);

const result = await mediaviz.keywords.addCompanyToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    companyId: '<COMPANY_ID>'
  }
);

const result = await mediaviz.keywords.addCompanyToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    companyId: '<COMPANY_ID>'
  }
);

result = mediaviz.keywords.add_company_to_keyword_filtering_list('<KEYWORD_LIST_ID>', company_id='<COMPANY_ID>')

$result = $mediaviz->keywords->addCompanyToKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  [
    'companyId' => '<COMPANY_ID>'
  ]
);

curl -X POST 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>/company' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Request Keyword List Export

Request Sample

const result = await mediaviz.keywords.requestKeywordListExport('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.requestKeywordListExport('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.requestKeywordListExport('<KEYWORD_LIST_ID>');

result = mediaviz.keywords.request_keyword_list_export('<KEYWORD_LIST_ID>')

$result = $mediaviz->keywords->requestKeywordListExport('<KEYWORD_LIST_ID>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/export/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Request Keyword List Export Status

Request Sample

const result = await mediaviz.keywords.requestKeywordListExportStatus('<KEYWORD_LIST_ID>');

import type { AnalysisStatusResponse } from '@mediaviz/sdk';

const result: AnalysisStatusResponse = await mediaviz.keywords.requestKeywordListExportStatus('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.requestKeywordListExportStatus('<KEYWORD_LIST_ID>');

result = mediaviz.keywords.request_keyword_list_export_status('<KEYWORD_LIST_ID>')

$result = $mediaviz->keywords->requestKeywordListExportStatus('<KEYWORD_LIST_ID>');

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/export_status/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Keywords And Ids

Request Sample

const result = await mediaviz.keywords.getKeywordsAndIds();

const result = await mediaviz.keywords.getKeywordsAndIds();

const result = await mediaviz.keywords.getKeywordsAndIds();

result = mediaviz.keywords.get_keywords_and_ids()

$result = $mediaviz->keywords->getKeywordsAndIds();

curl -X GET 'https://api.mediaviz.ai/api/v1/keyword/all_keywords/id/label' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Remove Projects From Keyword Filtering List

Request Sample

const result = await mediaviz.keywords.removeProjectsFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    projectIds: '<PROJECT_IDS>'
  }
);

const result = await mediaviz.keywords.removeProjectsFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    projectIds: '<PROJECT_IDS>'
  }
);

const result = await mediaviz.keywords.removeProjectsFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    projectIds: '<PROJECT_IDS>'
  }
);

result = mediaviz.keywords.remove_projects_from_keyword_filtering_list('<KEYWORD_LIST_ID>', project_ids='<PROJECT_IDS>')

$result = $mediaviz->keywords->removeProjectsFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  [
    'projectIds' => '<PROJECT_IDS>'
  ]
);

curl -X DELETE 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>/projects' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Remove Company From Keyword Filtering List

Request Sample

const result = await mediaviz.keywords.removeCompanyFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    companyId: '<COMPANY_ID>'
  }
);

const result = await mediaviz.keywords.removeCompanyFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    companyId: '<COMPANY_ID>'
  }
);

const result = await mediaviz.keywords.removeCompanyFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  {
    companyId: '<COMPANY_ID>'
  }
);

result = mediaviz.keywords.remove_company_from_keyword_filtering_list('<KEYWORD_LIST_ID>', company_id='<COMPANY_ID>')

$result = $mediaviz->keywords->removeCompanyFromKeywordFilteringList(
  '<KEYWORD_LIST_ID>',
  [
    'companyId' => '<COMPANY_ID>'
  ]
);

curl -X DELETE 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>/company' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Delete Keyword Filtering List By Id

Request Sample

const result = await mediaviz.keywords.deleteKeywordFilteringListById('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.deleteKeywordFilteringListById('<KEYWORD_LIST_ID>');

const result = await mediaviz.keywords.deleteKeywordFilteringListById('<KEYWORD_LIST_ID>');

result = mediaviz.keywords.delete_keyword_filtering_list_by_id('<KEYWORD_LIST_ID>')

$result = $mediaviz->keywords->deleteKeywordFilteringListById('<KEYWORD_LIST_ID>');

curl -X DELETE 'https://api.mediaviz.ai/api/v1/keyword/<KEYWORD_LIST_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'