client.media.list_ratecards

A method of the Media endpoint.

list_ratecards(*, archived: str = None, filename: str = None, dma_number: int = None) → ListResponse

List all ratecards

API URL: GET /media/ratecards

import civis
client = civis.APIClient()
response = client.media.list_ratecards(...)

Parameters:

archivedstr, optional

The archival status of the items to return. One of: true, false, all. A blank value is read as ‘false’, which is also the default.

filenamestr, optional

If specified, will be used to filter the ratecards returned. Substring matching is supported with “%” and “*” wildcards (e.g., “filename=%ratecard%” will return both “ratecard 1” and “my ratecard”).

dma_numberint, optional

If specified, will be used to filter the ratecards by DMA.

Returns:

civis.ListResponse

• idint

  The ratecard ID.

• filenamestr

  Name of the ratecard file.

• start_onstr (date)

  First day to which the ratecard applies.

• end_onstr (date)

  Last day to which the ratecard applies.

• dma_numberint

  Number of the DMA associated with the ratecard.

• archivedbool

  The archival status of the requested item(s).