Class: SiteimproveAPIClient::SeoV2Api

Inherits:
Object
  • Object
show all
Defined in:
lib/siteimprove_api_client/api/seo_v2_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SeoV2Api

Returns a new instance of SeoV2Api.



19
20
21
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#sites_site_id_seov2_activity_plans_get(site_id, opts = {}) ⇒ ActivityPlanList

Get activity plans Get all SEO activity plans on this site

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



30
31
32
33
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 30

def sites_site_id_seov2_activity_plans_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_get_with_http_info(site_id, opts = {}) ⇒ Array<(ActivityPlanList, Integer, Hash)>

Get activity plans Get all SEO activity plans on this site

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(ActivityPlanList, Integer, Hash)>) —

    ActivityPlanList data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 43

def sites_site_id_seov2_activity_plans_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ActivityPlanList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get(site_id, activity_plan_id, opts = {}) ⇒ CompetitorAnalysisVisibilityScoreTrendList

Get competitors for the specific activity plan Get all competitors for the activity plan

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



114
115
116
117
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 114

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get(site_id, activity_plan_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get_with_http_info(site_id, activity_plan_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get_with_http_info(site_id, activity_plan_id, opts = {}) ⇒ Array<(CompetitorAnalysisVisibilityScoreTrendList, Integer, Hash)>

Get competitors for the specific activity plan Get all competitors for the activity plan

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 127

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get_with_http_info(site_id, activity_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get"
  end
  # verify the required parameter 'activity_plan_id' is set
  if @api_client.config.client_side_validation && activity_plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_plan_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans/plans/{activity_plan_id}/competitors'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'activity_plan_id' + '}', CGI.escape(activity_plan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CompetitorAnalysisVisibilityScoreTrendList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get(site_id, activity_plan_id, opts = {}) ⇒ VisibilityScoreHistoryItemList

Get competitors search engine visibility historically Get yours and your competitors search engine visibility historically for the activity plan

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



202
203
204
205
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 202

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get(site_id, activity_plan_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get_with_http_info(site_id, activity_plan_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get_with_http_info(site_id, activity_plan_id, opts = {}) ⇒ Array<(VisibilityScoreHistoryItemList, Integer, Hash)>

Get competitors search engine visibility historically Get yours and your competitors search engine visibility historically for the activity plan

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 216

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get_with_http_info(site_id, activity_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get"
  end
  # verify the required parameter 'activity_plan_id' is set
  if @api_client.config.client_side_validation && activity_plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_plan_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans/plans/{activity_plan_id}/competitors/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'activity_plan_id' + '}', CGI.escape(activity_plan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'VisibilityScoreHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get(site_id, activity_plan_id, opts = {}) ⇒ PositionSpreadList

Get the position distribution of competitors Get the position distribution of your website and your competitors

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



291
292
293
294
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 291

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get(site_id, activity_plan_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get_with_http_info(site_id, activity_plan_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get_with_http_info(site_id, activity_plan_id, opts = {}) ⇒ Array<(PositionSpreadList, Integer, Hash)>

Get the position distribution of competitors Get the position distribution of your website and your competitors

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(PositionSpreadList, Integer, Hash)>) —

    PositionSpreadList data, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 304

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get_with_http_info(site_id, activity_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get"
  end
  # verify the required parameter 'activity_plan_id' is set
  if @api_client.config.client_side_validation && activity_plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_plan_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans/plans/{activity_plan_id}/competitors/positions'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'activity_plan_id' + '}', CGI.escape(activity_plan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PositionSpreadList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get(site_id, activity_plan_id, opts = {}) ⇒ PositionSpreadHistoryItemList

Get the position distribution for your competitors historically Get the historical position distribution of your website and your competitors

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :range (String) —

    The range of the keywords (default to ‘OneToThree’)

Returns:



379
380
381
382
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 379

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get(site_id, activity_plan_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get_with_http_info(site_id, activity_plan_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get_with_http_info(site_id, activity_plan_id, opts = {}) ⇒ Array<(PositionSpreadHistoryItemList, Integer, Hash)>

Get the position distribution for your competitors historically Get the historical position distribution of your website and your competitors

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :range (String) —

    The range of the keywords (default to ‘OneToThree’)

Returns:



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 393

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get_with_http_info(site_id, activity_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get"
  end
  # verify the required parameter 'activity_plan_id' is set
  if @api_client.config.client_side_validation && activity_plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_plan_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get, must be greater than or equal to 1.'
  end

  allowable_values = ["one_to_three", "four_to_six", "seven_to_ten", "eleven_to_twenty", "twenty_one_to_thirty", "thirty_one_to_fifty", "fifty_one_to_one_hundred"]
  if @api_client.config.client_side_validation && opts[:'range'] && !allowable_values.include?(opts[:'range'])
    fail ArgumentError, "invalid value for \"range\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans/plans/{activity_plan_id}/competitors/positions/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'activity_plan_id' + '}', CGI.escape(activity_plan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PositionSpreadHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_plans_activity_plan_id_competitors_positions_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get(site_id, activity_plan_id, opts = {}) ⇒ ActivityPlanHistoryItemList

Get historical metrics for the activity plan Get historical metrics for the activity plan

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



473
474
475
476
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 473

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get(site_id, activity_plan_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get_with_http_info(site_id, activity_plan_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get_with_http_info(site_id, activity_plan_id, opts = {}) ⇒ Array<(ActivityPlanHistoryItemList, Integer, Hash)>

Get historical metrics for the activity plan Get historical metrics for the activity plan

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • activity_plan_id (Integer) —

    Id for specific activity plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:

  • (Array<(ActivityPlanHistoryItemList, Integer, Hash)>) —

    ActivityPlanHistoryItemList data, response status code and response headers



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 487

def sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get_with_http_info(site_id, activity_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get"
  end
  # verify the required parameter 'activity_plan_id' is set
  if @api_client.config.client_side_validation && activity_plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_plan_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans/plans/{activity_plan_id}/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'activity_plan_id' + '}', CGI.escape(activity_plan_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ActivityPlanHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_plans_activity_plan_id_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_activity_plans_summary_get(site_id, opts = {}) ⇒ ActivityPlanHighlights

Get overall statistics for all activity plans Get overall statistics for all activity plans on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



559
560
561
562
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 559

def sites_site_id_seov2_activity_plans_summary_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_activity_plans_summary_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_activity_plans_summary_get_with_http_info(site_id, opts = {}) ⇒ Array<(ActivityPlanHighlights, Integer, Hash)>

Get overall statistics for all activity plans Get overall statistics for all activity plans on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ActivityPlanHighlights, Integer, Hash)>) —

    ActivityPlanHighlights data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 569

def sites_site_id_seov2_activity_plans_summary_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_activity_plans_summary_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_activity_plans_summary_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/activity_plans/summary'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ActivityPlanHighlights'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_activity_plans_summary_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_activity_plans_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_content_optimization_keywords_get(site_id, opts = {}) ⇒ ContentOptimizationKeywordList

Get content optimization keywords Get content optimization keywords on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



627
628
629
630
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 627

def sites_site_id_seov2_content_optimization_keywords_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_content_optimization_keywords_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_content_optimization_keywords_get_with_http_info(site_id, opts = {}) ⇒ Array<(ContentOptimizationKeywordList, Integer, Hash)>

Get content optimization keywords Get content optimization keywords on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 642

def sites_site_id_seov2_content_optimization_keywords_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_content_optimization_keywords_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_content_optimization_keywords_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_content_optimization_keywords_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_content_optimization_keywords_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_content_optimization_keywords_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/content_optimization_keywords'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'activity_plan_id'] = opts[:'activity_plan_id'] if !opts[:'activity_plan_id'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationKeywordList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_content_optimization_keywords_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_content_optimization_keywords_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_content_optimization_keywords_summary_get(site_id, opts = {}) ⇒ ContentOptimizationKeywordHighlights

Get overall statistics for content optimization keywords Get overall statistics for content optimization keywords on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

Returns:



713
714
715
716
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 713

def sites_site_id_seov2_content_optimization_keywords_summary_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_content_optimization_keywords_summary_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_content_optimization_keywords_summary_get_with_http_info(site_id, opts = {}) ⇒ Array<(ContentOptimizationKeywordHighlights, Integer, Hash)>

Get overall statistics for content optimization keywords Get overall statistics for content optimization keywords on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

Returns:



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 724

def sites_site_id_seov2_content_optimization_keywords_summary_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_content_optimization_keywords_summary_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_content_optimization_keywords_summary_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/content_optimization_keywords/summary'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'activity_plan_id'] = opts[:'activity_plan_id'] if !opts[:'activity_plan_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationKeywordHighlights'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_content_optimization_keywords_summary_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_content_optimization_keywords_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_broken_links_details_get(site_id, opts = {}) ⇒ InternalBrokenSeoLinksInfo

Get overall broken links stats Get the overall broken links stats for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



779
780
781
782
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 779

def sites_site_id_seov2_issues_broken_links_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_broken_links_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_broken_links_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(InternalBrokenSeoLinksInfo, Integer, Hash)>

Get overall broken links stats Get the overall broken links stats for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(InternalBrokenSeoLinksInfo, Integer, Hash)>) —

    InternalBrokenSeoLinksInfo data, response status code and response headers



790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 790

def sites_site_id_seov2_issues_broken_links_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_broken_links_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/broken_links/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InternalBrokenSeoLinksInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_broken_links_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_broken_links_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_broken_links_entry_pages_details_get(site_id, opts = {}) ⇒ InternalBrokenEntryPagesSeoLinksInfo

Get overall broken links stats for entry pages Get overall broken links stats for entry pages

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



845
846
847
848
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 845

def sites_site_id_seov2_issues_broken_links_entry_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_broken_links_entry_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_broken_links_entry_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(InternalBrokenEntryPagesSeoLinksInfo, Integer, Hash)>

Get overall broken links stats for entry pages Get overall broken links stats for entry pages

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 856

def sites_site_id_seov2_issues_broken_links_entry_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/broken_links_entry_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InternalBrokenEntryPagesSeoLinksInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_broken_links_entry_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_broken_links_entry_pages_get(site_id, opts = {}) ⇒ InternalBrokenSeoLinkList

Get broken links on entry pages Get broken links on entry pages for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



914
915
916
917
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 914

def sites_site_id_seov2_issues_broken_links_entry_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_broken_links_entry_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_broken_links_entry_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(InternalBrokenSeoLinkList, Integer, Hash)>

Get broken links on entry pages Get broken links on entry pages for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(InternalBrokenSeoLinkList, Integer, Hash)>) —

    InternalBrokenSeoLinkList data, response status code and response headers



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 928

def sites_site_id_seov2_issues_broken_links_entry_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/broken_links_entry_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InternalBrokenSeoLinkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_broken_links_entry_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_broken_links_entry_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get the occurrences of broken links on entry pages historically Get the occurrences of broken links on entry pages historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1000
1001
1002
1003
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1000

def sites_site_id_seov2_issues_broken_links_entry_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_broken_links_entry_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_broken_links_entry_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get the occurrences of broken links on entry pages historically Get the occurrences of broken links on entry pages historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1013

def sites_site_id_seov2_issues_broken_links_entry_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/broken_links_entry_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_broken_links_entry_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_broken_links_entry_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_broken_links_get(site_id, opts = {}) ⇒ InternalBrokenSeoLinkList

Get broken links Get the broken links from issues

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



1085
1086
1087
1088
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1085

def sites_site_id_seov2_issues_broken_links_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_broken_links_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_broken_links_get_with_http_info(site_id, opts = {}) ⇒ Array<(InternalBrokenSeoLinkList, Integer, Hash)>

Get broken links Get the broken links from issues

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(InternalBrokenSeoLinkList, Integer, Hash)>) —

    InternalBrokenSeoLinkList data, response status code and response headers



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1099

def sites_site_id_seov2_issues_broken_links_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_broken_links_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/broken_links'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InternalBrokenSeoLinkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_broken_links_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_broken_links_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_broken_links_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get the occurrences of broken links historically Get the occurrences of broken links historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1171
1172
1173
1174
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1171

def sites_site_id_seov2_issues_broken_links_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_broken_links_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_broken_links_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get the occurrences of broken links historically Get the occurrences of broken links historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1184

def sites_site_id_seov2_issues_broken_links_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_broken_links_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_broken_links_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/broken_links/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_broken_links_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_broken_links_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_canonical_urls_details_get(site_id, opts = {}) ⇒ CanonicalUrlsInfo

Get overall stats for canonical issue Get overall stats for canonical issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1253
1254
1255
1256
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1253

def sites_site_id_seov2_issues_canonical_urls_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_canonical_urls_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_canonical_urls_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(CanonicalUrlsInfo, Integer, Hash)>

Get overall stats for canonical issue Get overall stats for canonical issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(CanonicalUrlsInfo, Integer, Hash)>) —

    CanonicalUrlsInfo data, response status code and response headers



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1264

def sites_site_id_seov2_issues_canonical_urls_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_canonical_urls_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/canonical_urls/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CanonicalUrlsInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_canonical_urls_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_canonical_urls_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_canonical_urls_get(site_id, opts = {}) ⇒ PageWithCanonicalList

Get pages not linking to the canonical page Get pages not linking to the canonical page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



1324
1325
1326
1327
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1324

def sites_site_id_seov2_issues_canonical_urls_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_canonical_urls_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_canonical_urls_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithCanonicalList, Integer, Hash)>

Get pages not linking to the canonical page Get pages not linking to the canonical page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageWithCanonicalList, Integer, Hash)>) —

    PageWithCanonicalList data, response status code and response headers



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1340

def sites_site_id_seov2_issues_canonical_urls_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_canonical_urls_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/canonical_urls'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_id'] = opts[:'page_id'] if !opts[:'page_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithCanonicalList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_canonical_urls_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_canonical_urls_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_canonical_urls_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of canonical issue Get historical occurrences of canonical issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1418
1419
1420
1421
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1418

def sites_site_id_seov2_issues_canonical_urls_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_canonical_urls_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_canonical_urls_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of canonical issue Get historical occurrences of canonical issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1431

def sites_site_id_seov2_issues_canonical_urls_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_canonical_urls_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_canonical_urls_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/canonical_urls/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_canonical_urls_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_canonical_urls_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_code_text_ratio_details_get(site_id, opts = {}) ⇒ PagesCodeTextRatioInfo

Get overall stats of code to text ratio issue Get overall stats of code to text ratio issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1500
1501
1502
1503
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1500

def sites_site_id_seov2_issues_code_text_ratio_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_code_text_ratio_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_code_text_ratio_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesCodeTextRatioInfo, Integer, Hash)>

Get overall stats of code to text ratio issue Get overall stats of code to text ratio issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesCodeTextRatioInfo, Integer, Hash)>) —

    PagesCodeTextRatioInfo data, response status code and response headers



1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1511

def sites_site_id_seov2_issues_code_text_ratio_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/code_text_ratio/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesCodeTextRatioInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_code_text_ratio_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_code_text_ratio_get(site_id, opts = {}) ⇒ PageWithLowCodeTextRatioList

Get pages for code to text ratio issue Pages with text-to-code ratio below 30%

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



1570
1571
1572
1573
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1570

def sites_site_id_seov2_issues_code_text_ratio_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_code_text_ratio_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_code_text_ratio_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithLowCodeTextRatioList, Integer, Hash)>

Get pages for code to text ratio issue Pages with text-to-code ratio below 30%

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1585

def sites_site_id_seov2_issues_code_text_ratio_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/code_text_ratio'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithLowCodeTextRatioList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_code_text_ratio_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_code_text_ratio_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of code to text ratio issue Get historical occurrences of code to text ratio issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1662
1663
1664
1665
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1662

def sites_site_id_seov2_issues_code_text_ratio_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_code_text_ratio_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_code_text_ratio_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of code to text ratio issue Get historical occurrences of code to text ratio issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1675

def sites_site_id_seov2_issues_code_text_ratio_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/code_text_ratio/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_code_text_ratio_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_code_text_ratio_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_compression_used_details_get(site_id, opts = {}) ⇒ CompressionUsed

Get compression used issue Get compression used issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1743
1744
1745
1746
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1743

def sites_site_id_seov2_issues_compression_used_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_compression_used_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_compression_used_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(CompressionUsed, Integer, Hash)>

Get compression used issue Get compression used issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CompressionUsed, Integer, Hash)>) —

    CompressionUsed data, response status code and response headers



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1753

def sites_site_id_seov2_issues_compression_used_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_compression_used_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_compression_used_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/compression_used/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CompressionUsed'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_compression_used_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_compression_used_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_correct404s_details_get(site_id, opts = {}) ⇒ LinksStatusCodeCorrect404Info

Get overall stats for the correct 404 issue Get overall stats for the correct 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1807
1808
1809
1810
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1807

def sites_site_id_seov2_issues_correct404s_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_correct404s_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_correct404s_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinksStatusCodeCorrect404Info, Integer, Hash)>

Get overall stats for the correct 404 issue Get overall stats for the correct 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1818

def sites_site_id_seov2_issues_correct404s_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_correct404s_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/correct_404s/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinksStatusCodeCorrect404Info'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_correct404s_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_correct404s_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_correct404s_get(site_id, opts = {}) ⇒ Link404WithIncorrectStatusCodeList

Get links for the correct 404 issue Links should return correctly 404 when it’s a 404 and not be a "soft" 404.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



1876
1877
1878
1879
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1876

def sites_site_id_seov2_issues_correct404s_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_correct404s_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_correct404s_get_with_http_info(site_id, opts = {}) ⇒ Array<(Link404WithIncorrectStatusCodeList, Integer, Hash)>

Get links for the correct 404 issue Links should return correctly 404 when it&#39;s a 404 and not be a &quot;soft&quot; 404.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1890

def sites_site_id_seov2_issues_correct404s_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_correct404s_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/correct_404s'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Link404WithIncorrectStatusCodeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_correct404s_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_correct404s_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_correct404s_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of correct 404 issue Get historical occurrences of correct 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1962
1963
1964
1965
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1962

def sites_site_id_seov2_issues_correct404s_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_correct404s_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_correct404s_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of correct 404 issue Get historical occurrences of correct 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 1975

def sites_site_id_seov2_issues_correct404s_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_correct404s_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_correct404s_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/correct_404s/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_correct404s_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_correct404s_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_css_validation_details_get(site_id, opts = {}) ⇒ CssValidationErrorInfo

Get overall stats for the css validation issue Get overall stats for the css validation issue. This check is deprecated from November 2019. The data is still available but won’t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



2044
2045
2046
2047
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2044

def sites_site_id_seov2_issues_css_validation_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_css_validation_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_css_validation_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(CssValidationErrorInfo, Integer, Hash)>

Get overall stats for the css validation issue Get overall stats for the css validation issue. This check is deprecated from November 2019. The data is still available but won&#39;t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(CssValidationErrorInfo, Integer, Hash)>) —

    CssValidationErrorInfo data, response status code and response headers



2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2055

def sites_site_id_seov2_issues_css_validation_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_css_validation_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/css_validation/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CssValidationErrorInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_css_validation_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_css_validation_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_css_validation_get(site_id, opts = {}) ⇒ CssValidationErrorList

Get stylesheets for the css validation issue Get all stylesheets not passing css validation. This check is deprecated from November 2019. The data is still available but won’t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



2113
2114
2115
2116
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2113

def sites_site_id_seov2_issues_css_validation_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_css_validation_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_css_validation_get_with_http_info(site_id, opts = {}) ⇒ Array<(CssValidationErrorList, Integer, Hash)>

Get stylesheets for the css validation issue Get all stylesheets not passing css validation. This check is deprecated from November 2019. The data is still available but won&#39;t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(CssValidationErrorList, Integer, Hash)>) —

    CssValidationErrorList data, response status code and response headers



2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2127

def sites_site_id_seov2_issues_css_validation_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_css_validation_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/css_validation'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CssValidationErrorList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_css_validation_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_css_validation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_css_validation_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of css validation issue Get historical occurrences of css validation issue. This check is deprecated from November 2019. The data is still available but won’t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2199
2200
2201
2202
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2199

def sites_site_id_seov2_issues_css_validation_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_css_validation_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_css_validation_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of css validation issue Get historical occurrences of css validation issue. This check is deprecated from November 2019. The data is still available but won&#39;t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2212

def sites_site_id_seov2_issues_css_validation_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_css_validation_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_css_validation_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/css_validation/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_css_validation_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_css_validation_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_dead_end_pages_details_get(site_id, opts = {}) ⇒ DeadEndPagesInfo

Get overall stats for the dead end pages issue Get overall stats for the dead end pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



2281
2282
2283
2284
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2281

def sites_site_id_seov2_issues_dead_end_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_dead_end_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_dead_end_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(DeadEndPagesInfo, Integer, Hash)>

Get overall stats for the dead end pages issue Get overall stats for the dead end pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(DeadEndPagesInfo, Integer, Hash)>) —

    DeadEndPagesInfo data, response status code and response headers



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2292

def sites_site_id_seov2_issues_dead_end_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/dead_end_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeadEndPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_dead_end_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_dead_end_pages_get(site_id, opts = {}) ⇒ DeadEndPageList

Get dead end pages issue Get all the pages with no internal links

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



2351
2352
2353
2354
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2351

def sites_site_id_seov2_issues_dead_end_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_dead_end_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_dead_end_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(DeadEndPageList, Integer, Hash)>

Get dead end pages issue Get all the pages with no internal links

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(DeadEndPageList, Integer, Hash)>) —

    DeadEndPageList data, response status code and response headers



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2366

def sites_site_id_seov2_issues_dead_end_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/dead_end_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeadEndPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_dead_end_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_dead_end_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of dead end pages issue Get historical occurrences of dead end pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2443
2444
2445
2446
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2443

def sites_site_id_seov2_issues_dead_end_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_dead_end_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_dead_end_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of dead end pages issue Get historical occurrences of dead end pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2456

def sites_site_id_seov2_issues_dead_end_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/dead_end_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_dead_end_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_dead_end_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_desktop_speed_details_get(site_id, opts = {}) ⇒ DesktopSpeed

Get desktop speed issue Get desktop speed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2524
2525
2526
2527
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2524

def sites_site_id_seov2_issues_desktop_speed_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_desktop_speed_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_desktop_speed_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(DesktopSpeed, Integer, Hash)>

Get desktop speed issue Get desktop speed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DesktopSpeed, Integer, Hash)>) —

    DesktopSpeed data, response status code and response headers



2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2534

def sites_site_id_seov2_issues_desktop_speed_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_desktop_speed_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_desktop_speed_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/desktop_speed/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DesktopSpeed'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_desktop_speed_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_desktop_speed_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_desktop_speed_history_get(site_id, opts = {}) ⇒ DesktopSpeedHistoryItemList

Get the desktop speed score historically Get the desktop speed score historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2590
2591
2592
2593
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2590

def sites_site_id_seov2_issues_desktop_speed_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_desktop_speed_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_desktop_speed_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(DesktopSpeedHistoryItemList, Integer, Hash)>

Get the desktop speed score historically Get the desktop speed score historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(DesktopSpeedHistoryItemList, Integer, Hash)>) —

    DesktopSpeedHistoryItemList data, response status code and response headers



2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2603

def sites_site_id_seov2_issues_desktop_speed_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_desktop_speed_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_desktop_speed_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_desktop_speed_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_desktop_speed_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_desktop_speed_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/desktop_speed/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DesktopSpeedHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_desktop_speed_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_desktop_speed_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_duplicate_description_details_get(site_id, opts = {}) ⇒ DuplicateMetaDescriptionInfo

Get overall stats for duplicate meta description issue Get overall stats for duplicate meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



2672
2673
2674
2675
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2672

def sites_site_id_seov2_issues_duplicate_description_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_duplicate_description_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_duplicate_description_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(DuplicateMetaDescriptionInfo, Integer, Hash)>

Get overall stats for duplicate meta description issue Get overall stats for duplicate meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2683

def sites_site_id_seov2_issues_duplicate_description_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_duplicate_description_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/duplicate_description/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DuplicateMetaDescriptionInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_duplicate_description_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_duplicate_description_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_duplicate_description_get(site_id, opts = {}) ⇒ MetaDescriptionValueList

Get duplicate description issue Get all duplicate meta descriptions

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



2741
2742
2743
2744
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2741

def sites_site_id_seov2_issues_duplicate_description_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_duplicate_description_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_duplicate_description_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionValueList, Integer, Hash)>

Get duplicate description issue Get all duplicate meta descriptions

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaDescriptionValueList, Integer, Hash)>) —

    MetaDescriptionValueList data, response status code and response headers



2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2755

def sites_site_id_seov2_issues_duplicate_description_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_duplicate_description_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/duplicate_description'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionValueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_duplicate_description_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_duplicate_description_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_duplicate_description_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of duplicate description issue Get historical occurrences of duplicate meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2827
2828
2829
2830
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2827

def sites_site_id_seov2_issues_duplicate_description_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_duplicate_description_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_duplicate_description_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of duplicate description issue Get historical occurrences of duplicate meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2840

def sites_site_id_seov2_issues_duplicate_description_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_duplicate_description_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_description_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/duplicate_description/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_duplicate_description_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_duplicate_description_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_duplicate_page_title_details_get(site_id, opts = {}) ⇒ DuplicateMetaTitleInfo

Get overall stats for duplicate page title issue Get overall stats for duplicate page title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



2909
2910
2911
2912
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2909

def sites_site_id_seov2_issues_duplicate_page_title_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_duplicate_page_title_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_duplicate_page_title_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(DuplicateMetaTitleInfo, Integer, Hash)>

Get overall stats for duplicate page title issue Get overall stats for duplicate page title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(DuplicateMetaTitleInfo, Integer, Hash)>) —

    DuplicateMetaTitleInfo data, response status code and response headers



2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2920

def sites_site_id_seov2_issues_duplicate_page_title_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/duplicate_page_title/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DuplicateMetaTitleInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_duplicate_page_title_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_duplicate_page_title_get(site_id, opts = {}) ⇒ DuplicateMetaTitleValueList

Get duplicate page title issue Get all the duplicate page titles

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



2978
2979
2980
2981
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2978

def sites_site_id_seov2_issues_duplicate_page_title_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_duplicate_page_title_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_duplicate_page_title_get_with_http_info(site_id, opts = {}) ⇒ Array<(DuplicateMetaTitleValueList, Integer, Hash)>

Get duplicate page title issue Get all the duplicate page titles

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(DuplicateMetaTitleValueList, Integer, Hash)>) —

    DuplicateMetaTitleValueList data, response status code and response headers



2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 2992

def sites_site_id_seov2_issues_duplicate_page_title_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/duplicate_page_title'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DuplicateMetaTitleValueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_duplicate_page_title_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_duplicate_page_title_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of duplicate page title issue Get historical occurrences of duplicate page title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3064
3065
3066
3067
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3064

def sites_site_id_seov2_issues_duplicate_page_title_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_duplicate_page_title_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_duplicate_page_title_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of duplicate page title issue Get historical occurrences of duplicate page title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3077

def sites_site_id_seov2_issues_duplicate_page_title_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/duplicate_page_title/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_duplicate_page_title_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_duplicate_page_title_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_empty_h1_details_get(site_id, opts = {}) ⇒ H1EmptyInfo

Get overall stats for empty H1 issue Get overall stats for empty H1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



3146
3147
3148
3149
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3146

def sites_site_id_seov2_issues_empty_h1_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_empty_h1_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_empty_h1_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(H1EmptyInfo, Integer, Hash)>

Get overall stats for empty H1 issue Get overall stats for empty H1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(H1EmptyInfo, Integer, Hash)>) —

    H1EmptyInfo data, response status code and response headers



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3157

def sites_site_id_seov2_issues_empty_h1_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_empty_h1_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/empty_h1/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'H1EmptyInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_empty_h1_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_empty_h1_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_empty_h1_get(site_id, opts = {}) ⇒ H1IssuePageList

Get empty H1 issue Get all pages with an empty H1

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



3216
3217
3218
3219
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3216

def sites_site_id_seov2_issues_empty_h1_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_empty_h1_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_empty_h1_get_with_http_info(site_id, opts = {}) ⇒ Array<(H1IssuePageList, Integer, Hash)>

Get empty H1 issue Get all pages with an empty H1

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(H1IssuePageList, Integer, Hash)>) —

    H1IssuePageList data, response status code and response headers



3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3231

def sites_site_id_seov2_issues_empty_h1_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_empty_h1_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/empty_h1'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'H1IssuePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_empty_h1_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_empty_h1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_empty_h1_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of empty H1 issue Get historical occurrences of empty H1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3308
3309
3310
3311
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3308

def sites_site_id_seov2_issues_empty_h1_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_empty_h1_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_empty_h1_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of empty H1 issue Get historical occurrences of empty H1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3321

def sites_site_id_seov2_issues_empty_h1_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_empty_h1_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_empty_h1_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/empty_h1/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_empty_h1_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_empty_h1_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_fontsize_legibility_details_get(site_id, opts = {}) ⇒ FontsizeLegibility

Get font size legibility issue Get font size legibility issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3389
3390
3391
3392
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3389

def sites_site_id_seov2_issues_fontsize_legibility_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_fontsize_legibility_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_fontsize_legibility_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(FontsizeLegibility, Integer, Hash)>

Get font size legibility issue Get font size legibility issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FontsizeLegibility, Integer, Hash)>) —

    FontsizeLegibility data, response status code and response headers



3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3399

def sites_site_id_seov2_issues_fontsize_legibility_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_fontsize_legibility_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_fontsize_legibility_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/fontsize_legibility/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FontsizeLegibility'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_fontsize_legibility_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_fontsize_legibility_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_get(site_id, opts = {}) ⇒ SeoIssueWithRecommendationList

Get issues Get all SEO issues on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String) —

    The category filter (default to ‘none’)

  • :complexity (String) —

    The complexity filter (default to ‘none’)

  • :fixed (Boolean) —

    The fixed filter

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3459
3460
3461
3462
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3459

def sites_site_id_seov2_issues_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueWithRecommendationList, Integer, Hash)>

Get issues Get all SEO issues on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String) —

    The category filter (default to ‘none’)

  • :complexity (String) —

    The complexity filter (default to ‘none’)

  • :fixed (Boolean) —

    The fixed filter

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3476

def sites_site_id_seov2_issues_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_get"
  end
  allowable_values = ["none", "technical", "content", "ux", "mobile"]
  if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
    fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
  end
  allowable_values = ["none", "low", "medium", "high", "extreme"]
  if @api_client.config.client_side_validation && opts[:'complexity'] && !allowable_values.include?(opts[:'complexity'])
    fail ArgumentError, "invalid value for \"complexity\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'complexity'] = opts[:'complexity'] if !opts[:'complexity'].nil?
  query_params[:'fixed'] = opts[:'fixed'] if !opts[:'fixed'].nil?
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_id'] = opts[:'page_id'] if !opts[:'page_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueWithRecommendationList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_html_validation_details_get(site_id, opts = {}) ⇒ HtmlValidationSeoPagesInfo

Get overall stats for html validation issue Get overall stats for html validation issue. This check is deprecated from November 2019. The data is still available but won’t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



3557
3558
3559
3560
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3557

def sites_site_id_seov2_issues_html_validation_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_html_validation_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_html_validation_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(HtmlValidationSeoPagesInfo, Integer, Hash)>

Get overall stats for html validation issue Get overall stats for html validation issue. This check is deprecated from November 2019. The data is still available but won&#39;t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(HtmlValidationSeoPagesInfo, Integer, Hash)>) —

    HtmlValidationSeoPagesInfo data, response status code and response headers



3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3568

def sites_site_id_seov2_issues_html_validation_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_html_validation_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/html_validation/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'HtmlValidationSeoPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_html_validation_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_html_validation_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_html_validation_get(site_id, opts = {}) ⇒ HtmlValidationSeoPageList

Get html validation issue Get all the pages which do not pass html validation. This check is deprecated from November 2019. The data is still available but won’t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



3627
3628
3629
3630
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3627

def sites_site_id_seov2_issues_html_validation_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_html_validation_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_html_validation_get_with_http_info(site_id, opts = {}) ⇒ Array<(HtmlValidationSeoPageList, Integer, Hash)>

Get html validation issue Get all the pages which do not pass html validation. This check is deprecated from November 2019. The data is still available but won&#39;t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(HtmlValidationSeoPageList, Integer, Hash)>) —

    HtmlValidationSeoPageList data, response status code and response headers



3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3642

def sites_site_id_seov2_issues_html_validation_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_html_validation_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/html_validation'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'HtmlValidationSeoPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_html_validation_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_html_validation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_html_validation_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of html validation issue Get historical occurrences of html validation issue. This check is deprecated from November 2019. The data is still available but won’t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3719
3720
3721
3722
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3719

def sites_site_id_seov2_issues_html_validation_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_html_validation_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_html_validation_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of html validation issue Get historical occurrences of html validation issue. This check is deprecated from November 2019. The data is still available but won&#39;t get updated.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3732

def sites_site_id_seov2_issues_html_validation_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_html_validation_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_html_validation_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/html_validation/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_html_validation_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_html_validation_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_alt_attribute_details_get(site_id, opts = {}) ⇒ ImagesWithMissingImageAltAttributeInfo

Get overall stats for image alt attribute issue Get overall stats for image alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



3801
3802
3803
3804
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3801

def sites_site_id_seov2_issues_image_alt_attribute_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_alt_attribute_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_alt_attribute_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(ImagesWithMissingImageAltAttributeInfo, Integer, Hash)>

Get overall stats for image alt attribute issue Get overall stats for image alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3812

def sites_site_id_seov2_issues_image_alt_attribute_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_alt_attribute/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImagesWithMissingImageAltAttributeInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_alt_attribute_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_alt_attribute_get(site_id, opts = {}) ⇒ PageWithMissingImageAltAttributeList

Get image alt attribute issue Get all pages where an image is missing an alt attribute

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



3871
3872
3873
3874
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3871

def sites_site_id_seov2_issues_image_alt_attribute_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_alt_attribute_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_alt_attribute_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithMissingImageAltAttributeList, Integer, Hash)>

Get image alt attribute issue Get all pages where an image is missing an alt attribute

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3886

def sites_site_id_seov2_issues_image_alt_attribute_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_alt_attribute'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithMissingImageAltAttributeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_alt_attribute_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_alt_attribute_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of image alt attribute issue Get historical occurrences of image alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3963
3964
3965
3966
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3963

def sites_site_id_seov2_issues_image_alt_attribute_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_alt_attribute_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_alt_attribute_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of image alt attribute issue Get historical occurrences of image alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 3976

def sites_site_id_seov2_issues_image_alt_attribute_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_alt_attribute/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_alt_attribute_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_alt_attribute_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_empty_alt_attribute_details_get(site_id, opts = {}) ⇒ ImagesWithEmptyImageAltAttributeInfo

Get overall stats for image empty alt attribute issue Get overall stats for image empty alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



4045
4046
4047
4048
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4045

def sites_site_id_seov2_issues_image_empty_alt_attribute_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_empty_alt_attribute_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_empty_alt_attribute_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(ImagesWithEmptyImageAltAttributeInfo, Integer, Hash)>

Get overall stats for image empty alt attribute issue Get overall stats for image empty alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4056

def sites_site_id_seov2_issues_image_empty_alt_attribute_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_empty_alt_attribute/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImagesWithEmptyImageAltAttributeInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_empty_alt_attribute_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_empty_alt_attribute_get(site_id, opts = {}) ⇒ PageWithEmptyImageAltAttributeList

Get image empty alt attribute issue Get all pages with images that has an empty attribute

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



4115
4116
4117
4118
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4115

def sites_site_id_seov2_issues_image_empty_alt_attribute_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_empty_alt_attribute_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_empty_alt_attribute_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithEmptyImageAltAttributeList, Integer, Hash)>

Get image empty alt attribute issue Get all pages with images that has an empty attribute

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4130

def sites_site_id_seov2_issues_image_empty_alt_attribute_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_empty_alt_attribute'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithEmptyImageAltAttributeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_empty_alt_attribute_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_empty_alt_attribute_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of image empty alt attribute issue Get historical occurrences of image empty alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4207
4208
4209
4210
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4207

def sites_site_id_seov2_issues_image_empty_alt_attribute_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_empty_alt_attribute_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_empty_alt_attribute_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of image empty alt attribute issue Get historical occurrences of image empty alt attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4220

def sites_site_id_seov2_issues_image_empty_alt_attribute_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_empty_alt_attribute/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_empty_alt_attribute_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_empty_alt_attribute_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_width_height_attribute_details_get(site_id, opts = {}) ⇒ ImagesWithMissingWidthHeightAttributeInfo

Get overall stats for image width height attribute issue Get overall stats for image width height attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



4289
4290
4291
4292
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4289

def sites_site_id_seov2_issues_image_width_height_attribute_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_width_height_attribute_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_width_height_attribute_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(ImagesWithMissingWidthHeightAttributeInfo, Integer, Hash)>

Get overall stats for image width height attribute issue Get overall stats for image width height attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4300

def sites_site_id_seov2_issues_image_width_height_attribute_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_width_height_attribute/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImagesWithMissingWidthHeightAttributeInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_width_height_attribute_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_width_height_attribute_get(site_id, opts = {}) ⇒ PageWithMissingImageWidthHeightAttributeList

Get image with height attribute issue Get all pages with an image missing width and/or height attributes

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



4359
4360
4361
4362
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4359

def sites_site_id_seov2_issues_image_width_height_attribute_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_width_height_attribute_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_width_height_attribute_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithMissingImageWidthHeightAttributeList, Integer, Hash)>

Get image with height attribute issue Get all pages with an image missing width and/or height attributes

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4374

def sites_site_id_seov2_issues_image_width_height_attribute_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_width_height_attribute'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithMissingImageWidthHeightAttributeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_width_height_attribute_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_image_width_height_attribute_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of image width height attribute issue Get historical occurrences of image width height attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4451
4452
4453
4454
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4451

def sites_site_id_seov2_issues_image_width_height_attribute_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_image_width_height_attribute_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_image_width_height_attribute_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of image width height attribute issue Get historical occurrences of image width height attribute issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4464

def sites_site_id_seov2_issues_image_width_height_attribute_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/image_width_height_attribute/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_image_width_height_attribute_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_image_width_height_attribute_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_images1mb_details_get(site_id, opts = {}) ⇒ ImagesLargerThan1MbInfo

Get overall stats for images over 1mb issue Get overall stats for images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



4533
4534
4535
4536
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4533

def sites_site_id_seov2_issues_images1mb_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_images1mb_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_images1mb_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(ImagesLargerThan1MbInfo, Integer, Hash)>

Get overall stats for images over 1mb issue Get overall stats for images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(ImagesLargerThan1MbInfo, Integer, Hash)>) —

    ImagesLargerThan1MbInfo data, response status code and response headers



4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4544

def sites_site_id_seov2_issues_images1mb_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_images1mb_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/images_1mb/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImagesLargerThan1MbInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_images1mb_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_images1mb_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_images1mb_get(site_id, opts = {}) ⇒ ImagesLargerThan1MbList

Get images over 1mb issue Get all images that are larger than 1 mb

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



4603
4604
4605
4606
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4603

def sites_site_id_seov2_issues_images1mb_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_images1mb_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_images1mb_get_with_http_info(site_id, opts = {}) ⇒ Array<(ImagesLargerThan1MbList, Integer, Hash)>

Get images over 1mb issue Get all images that are larger than 1 mb

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(ImagesLargerThan1MbList, Integer, Hash)>) —

    ImagesLargerThan1MbList data, response status code and response headers



4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4618

def sites_site_id_seov2_issues_images1mb_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_images1mb_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/images_1mb'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_id'] = opts[:'page_id'] if !opts[:'page_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImagesLargerThan1MbList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_images1mb_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_images1mb_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_images1mb_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of images over 1mb issue Get historical occurrences of images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4691
4692
4693
4694
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4691

def sites_site_id_seov2_issues_images1mb_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_images1mb_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_images1mb_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of images over 1mb issue Get historical occurrences of images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4704

def sites_site_id_seov2_issues_images1mb_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_images1mb_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_images1mb_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/images_1mb/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_images1mb_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_images1mb_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_links_to_unsafe_domains_details_get(site_id, opts = {}) ⇒ UnsafeDomainsSeoInfo

Get overall stats for links to unsafe domains issue Get overall stats for links to unsafe domains issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



4773
4774
4775
4776
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4773

def sites_site_id_seov2_issues_links_to_unsafe_domains_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_links_to_unsafe_domains_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_links_to_unsafe_domains_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(UnsafeDomainsSeoInfo, Integer, Hash)>

Get overall stats for links to unsafe domains issue Get overall stats for links to unsafe domains issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(UnsafeDomainsSeoInfo, Integer, Hash)>) —

    UnsafeDomainsSeoInfo data, response status code and response headers



4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4784

def sites_site_id_seov2_issues_links_to_unsafe_domains_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/links_to_unsafe_domains/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnsafeDomainsSeoInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_links_to_unsafe_domains_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_links_to_unsafe_domains_get(site_id, opts = {}) ⇒ UnsafeDomainSeoLinkList

Get links to unsafe domains issue Get all links which link to a domain considered unsafe

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



4842
4843
4844
4845
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4842

def sites_site_id_seov2_issues_links_to_unsafe_domains_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_links_to_unsafe_domains_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_links_to_unsafe_domains_get_with_http_info(site_id, opts = {}) ⇒ Array<(UnsafeDomainSeoLinkList, Integer, Hash)>

Get links to unsafe domains issue Get all links which link to a domain considered unsafe

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(UnsafeDomainSeoLinkList, Integer, Hash)>) —

    UnsafeDomainSeoLinkList data, response status code and response headers



4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4856

def sites_site_id_seov2_issues_links_to_unsafe_domains_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/links_to_unsafe_domains'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnsafeDomainSeoLinkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_links_to_unsafe_domains_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_links_to_unsafe_domains_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of unsafe domains issue Get historical occurrences of unsafe domains issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4928
4929
4930
4931
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4928

def sites_site_id_seov2_issues_links_to_unsafe_domains_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_links_to_unsafe_domains_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_links_to_unsafe_domains_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of unsafe domains issue Get historical occurrences of unsafe domains issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 4941

def sites_site_id_seov2_issues_links_to_unsafe_domains_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/links_to_unsafe_domains/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_links_to_unsafe_domains_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_links_to_unsafe_domains_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_load_time_details_get(site_id, opts = {}) ⇒ SlowSeoPagesInfo

Get overall stats for load time issue Get overall stats for load time issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



5010
5011
5012
5013
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5010

def sites_site_id_seov2_issues_load_time_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_load_time_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_load_time_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(SlowSeoPagesInfo, Integer, Hash)>

Get overall stats for load time issue Get overall stats for load time issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(SlowSeoPagesInfo, Integer, Hash)>) —

    SlowSeoPagesInfo data, response status code and response headers



5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5021

def sites_site_id_seov2_issues_load_time_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_load_time_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_load_time_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/load_time/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SlowSeoPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_load_time_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_load_time_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_load_time_get(site_id, opts = {}) ⇒ SlowSeoPageList

Get load time issue Get all pages with loading time exceeding 2 seconds

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



5080
5081
5082
5083
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5080

def sites_site_id_seov2_issues_load_time_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_load_time_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_load_time_get_with_http_info(site_id, opts = {}) ⇒ Array<(SlowSeoPageList, Integer, Hash)>

Get load time issue Get all pages with loading time exceeding 2 seconds

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(SlowSeoPageList, Integer, Hash)>) —

    SlowSeoPageList data, response status code and response headers



5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5095

def sites_site_id_seov2_issues_load_time_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_load_time_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_load_time_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_load_time_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_load_time_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_load_time_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/load_time'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SlowSeoPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_load_time_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_load_time_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_load_time_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of load time issue Get historical occurrences of load time issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5172
5173
5174
5175
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5172

def sites_site_id_seov2_issues_load_time_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_load_time_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_load_time_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of load time issue Get historical occurrences of load time issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5185

def sites_site_id_seov2_issues_load_time_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_load_time_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_load_time_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_load_time_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_load_time_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_load_time_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/load_time/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_load_time_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_load_time_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_long_sentences_details_get(site_id, opts = {}) ⇒ LongSentencePagesInfo

Get overall stats for the long sentences issue Get overall stats for the long sentences issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



5254
5255
5256
5257
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5254

def sites_site_id_seov2_issues_long_sentences_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_long_sentences_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_long_sentences_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(LongSentencePagesInfo, Integer, Hash)>

Get overall stats for the long sentences issue Get overall stats for the long sentences issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(LongSentencePagesInfo, Integer, Hash)>) —

    LongSentencePagesInfo data, response status code and response headers



5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5265

def sites_site_id_seov2_issues_long_sentences_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_long_sentences_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/long_sentences/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LongSentencePagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_long_sentences_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_long_sentences_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_long_sentences_get(site_id, opts = {}) ⇒ LongSentencePageList

Get long sentences issue Get all pages with sentences longer than 20 words.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



5324
5325
5326
5327
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5324

def sites_site_id_seov2_issues_long_sentences_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_long_sentences_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_long_sentences_get_with_http_info(site_id, opts = {}) ⇒ Array<(LongSentencePageList, Integer, Hash)>

Get long sentences issue Get all pages with sentences longer than 20 words.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(LongSentencePageList, Integer, Hash)>) —

    LongSentencePageList data, response status code and response headers



5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5339

def sites_site_id_seov2_issues_long_sentences_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_long_sentences_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/long_sentences'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LongSentencePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_long_sentences_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_long_sentences_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_long_sentences_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of long sentences issue Get historical occurrences of long sentences issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5416
5417
5418
5419
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5416

def sites_site_id_seov2_issues_long_sentences_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_long_sentences_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_long_sentences_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of long sentences issue Get historical occurrences of long sentences issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5429

def sites_site_id_seov2_issues_long_sentences_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_long_sentences_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_sentences_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/long_sentences/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_long_sentences_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_long_sentences_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_long_urls_details_get(site_id, opts = {}) ⇒ PagesWithLongUrlsInfo

Get overall stats for long urls issue Get overall stats for long urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



5498
5499
5500
5501
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5498

def sites_site_id_seov2_issues_long_urls_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_long_urls_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_long_urls_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithLongUrlsInfo, Integer, Hash)>

Get overall stats for long urls issue Get overall stats for long urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesWithLongUrlsInfo, Integer, Hash)>) —

    PagesWithLongUrlsInfo data, response status code and response headers



5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5509

def sites_site_id_seov2_issues_long_urls_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_long_urls_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/long_urls/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithLongUrlsInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_long_urls_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_long_urls_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_long_urls_get(site_id, opts = {}) ⇒ PageWithLongUrlList

Get long urls issue Get all pages with long urls

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



5569
5570
5571
5572
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5569

def sites_site_id_seov2_issues_long_urls_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_long_urls_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_long_urls_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithLongUrlList, Integer, Hash)>

Get long urls issue Get all pages with long urls

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageWithLongUrlList, Integer, Hash)>) —

    PageWithLongUrlList data, response status code and response headers



5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5585

def sites_site_id_seov2_issues_long_urls_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_long_urls_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/long_urls'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_id'] = opts[:'page_id'] if !opts[:'page_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithLongUrlList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_long_urls_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_long_urls_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_long_urls_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of long urls issue Get historical occurrences of long urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5663
5664
5665
5666
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5663

def sites_site_id_seov2_issues_long_urls_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_long_urls_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_long_urls_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of long urls issue Get historical occurrences of long urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5676

def sites_site_id_seov2_issues_long_urls_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_long_urls_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_long_urls_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/long_urls/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_long_urls_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_long_urls_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_many_internal_links_details_get(site_id, opts = {}) ⇒ ManyInternalLinksInfo

Get overall stats for the many internal links issue Get overall stats for the many internal links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



5745
5746
5747
5748
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5745

def sites_site_id_seov2_issues_many_internal_links_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_many_internal_links_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_many_internal_links_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(ManyInternalLinksInfo, Integer, Hash)>

Get overall stats for the many internal links issue Get overall stats for the many internal links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(ManyInternalLinksInfo, Integer, Hash)>) —

    ManyInternalLinksInfo data, response status code and response headers



5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5756

def sites_site_id_seov2_issues_many_internal_links_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_many_internal_links_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/many_internal_links/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ManyInternalLinksInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_many_internal_links_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_many_internal_links_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_many_internal_links_get(site_id, opts = {}) ⇒ ManyInternalLinksPageList

Get many internal links issue Get all pages with 60 or more internal links

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



5815
5816
5817
5818
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5815

def sites_site_id_seov2_issues_many_internal_links_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_many_internal_links_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_many_internal_links_get_with_http_info(site_id, opts = {}) ⇒ Array<(ManyInternalLinksPageList, Integer, Hash)>

Get many internal links issue Get all pages with 60 or more internal links

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(ManyInternalLinksPageList, Integer, Hash)>) —

    ManyInternalLinksPageList data, response status code and response headers



5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5830

def sites_site_id_seov2_issues_many_internal_links_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_many_internal_links_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/many_internal_links'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ManyInternalLinksPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_many_internal_links_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_many_internal_links_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_many_internal_links_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of many internal links issue Get historical occurrences of many internal links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5907
5908
5909
5910
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5907

def sites_site_id_seov2_issues_many_internal_links_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_many_internal_links_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_many_internal_links_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of many internal links issue Get historical occurrences of many internal links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5920

def sites_site_id_seov2_issues_many_internal_links_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_many_internal_links_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_many_internal_links_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/many_internal_links/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_many_internal_links_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_many_internal_links_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_empty_details_get(site_id, opts = {}) ⇒ MetaDescriptionEmptyInfo

Get overall stats for meta description empty issue Get overall stats for meta description empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



5989
5990
5991
5992
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 5989

def sites_site_id_seov2_issues_meta_desc_empty_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_empty_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_empty_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionEmptyInfo, Integer, Hash)>

Get overall stats for meta description empty issue Get overall stats for meta description empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaDescriptionEmptyInfo, Integer, Hash)>) —

    MetaDescriptionEmptyInfo data, response status code and response headers



6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6000

def sites_site_id_seov2_issues_meta_desc_empty_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_empty/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionEmptyInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_empty_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_empty_get(site_id, opts = {}) ⇒ MetaDescriptionPageList

Get meta description empty issue Get all pages with an empty meta description

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



6059
6060
6061
6062
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6059

def sites_site_id_seov2_issues_meta_desc_empty_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_empty_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_empty_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionPageList, Integer, Hash)>

Get meta description empty issue Get all pages with an empty meta description

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(MetaDescriptionPageList, Integer, Hash)>) —

    MetaDescriptionPageList data, response status code and response headers



6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6074

def sites_site_id_seov2_issues_meta_desc_empty_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_empty'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_empty_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_empty_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta description empty issue Get historical occurrences of meta description empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6151
6152
6153
6154
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6151

def sites_site_id_seov2_issues_meta_desc_empty_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_empty_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_empty_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta description empty issue Get historical occurrences of meta description empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6164

def sites_site_id_seov2_issues_meta_desc_empty_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_empty/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_empty_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_empty_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_long_details_get(site_id, opts = {}) ⇒ MetaDescriptionTooLongInfo

Get overall stats for meta description too long issue Get overall stats for meta description too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



6233
6234
6235
6236
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6233

def sites_site_id_seov2_issues_meta_desc_long_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_long_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_long_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionTooLongInfo, Integer, Hash)>

Get overall stats for meta description too long issue Get overall stats for meta description too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaDescriptionTooLongInfo, Integer, Hash)>) —

    MetaDescriptionTooLongInfo data, response status code and response headers



6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6244

def sites_site_id_seov2_issues_meta_desc_long_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_long/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionTooLongInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_long_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_long_get(site_id, opts = {}) ⇒ MetaDescriptionValueList

Get meta description too long issue Get all pages with meta descriptions that are too long

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



6302
6303
6304
6305
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6302

def sites_site_id_seov2_issues_meta_desc_long_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_long_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_long_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionValueList, Integer, Hash)>

Get meta description too long issue Get all pages with meta descriptions that are too long

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaDescriptionValueList, Integer, Hash)>) —

    MetaDescriptionValueList data, response status code and response headers



6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6316

def sites_site_id_seov2_issues_meta_desc_long_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_long'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionValueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_long_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_long_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta description too long issue Get historical occurrences of meta description too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6388
6389
6390
6391
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6388

def sites_site_id_seov2_issues_meta_desc_long_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_long_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_long_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta description too long issue Get historical occurrences of meta description too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6401

def sites_site_id_seov2_issues_meta_desc_long_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_long/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_long_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_long_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_missing_details_get(site_id, opts = {}) ⇒ MetaDescriptionMissingInfo

Get overall stats for meta description missing issue Get overall stats for meta description missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



6470
6471
6472
6473
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6470

def sites_site_id_seov2_issues_meta_desc_missing_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_missing_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_missing_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionMissingInfo, Integer, Hash)>

Get overall stats for meta description missing issue Get overall stats for meta description missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaDescriptionMissingInfo, Integer, Hash)>) —

    MetaDescriptionMissingInfo data, response status code and response headers



6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6481

def sites_site_id_seov2_issues_meta_desc_missing_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_missing/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionMissingInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_missing_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_missing_get(site_id, opts = {}) ⇒ MetaDescriptionPageList

Get meta description empty issue Get all pages with a missing meta description

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



6540
6541
6542
6543
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6540

def sites_site_id_seov2_issues_meta_desc_missing_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_missing_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_missing_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionPageList, Integer, Hash)>

Get meta description empty issue Get all pages with a missing meta description

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(MetaDescriptionPageList, Integer, Hash)>) —

    MetaDescriptionPageList data, response status code and response headers



6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6555

def sites_site_id_seov2_issues_meta_desc_missing_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_missing'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_missing_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_missing_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta description missing issue Get historical occurrences of meta description missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6632
6633
6634
6635
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6632

def sites_site_id_seov2_issues_meta_desc_missing_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_missing_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_missing_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta description missing issue Get historical occurrences of meta description missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6645

def sites_site_id_seov2_issues_meta_desc_missing_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_missing/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_missing_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_missing_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_multiple_details_get(site_id, opts = {}) ⇒ MetaDescriptionMultipleInfo

Get overall stats for multiple meta description issue Get overall stats for multiple meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



6714
6715
6716
6717
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6714

def sites_site_id_seov2_issues_meta_desc_multiple_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_multiple_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_multiple_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionMultipleInfo, Integer, Hash)>

Get overall stats for multiple meta description issue Get overall stats for multiple meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaDescriptionMultipleInfo, Integer, Hash)>) —

    MetaDescriptionMultipleInfo data, response status code and response headers



6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6725

def sites_site_id_seov2_issues_meta_desc_multiple_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_multiple/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionMultipleInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_multiple_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_multiple_get(site_id, opts = {}) ⇒ MultipleMetaDescriptionPageList

Get multiple meta description issue Get all pages with multiple meta descriptions

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



6784
6785
6786
6787
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6784

def sites_site_id_seov2_issues_meta_desc_multiple_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_multiple_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_multiple_get_with_http_info(site_id, opts = {}) ⇒ Array<(MultipleMetaDescriptionPageList, Integer, Hash)>

Get multiple meta description issue Get all pages with multiple meta descriptions

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6799

def sites_site_id_seov2_issues_meta_desc_multiple_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_multiple'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MultipleMetaDescriptionPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_multiple_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_multiple_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of multiple meta description issue Get historical occurrences of multiple meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6876
6877
6878
6879
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6876

def sites_site_id_seov2_issues_meta_desc_multiple_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_multiple_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_multiple_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of multiple meta description issue Get historical occurrences of multiple meta description issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6889

def sites_site_id_seov2_issues_meta_desc_multiple_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_multiple/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_multiple_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_multiple_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_short_details_get(site_id, opts = {}) ⇒ MetaDescriptionTooShortInfo

Get overall stats for meta description too short issue Get overall stats for meta description too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



6958
6959
6960
6961
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6958

def sites_site_id_seov2_issues_meta_desc_short_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_short_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_short_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionTooShortInfo, Integer, Hash)>

Get overall stats for meta description too short issue Get overall stats for meta description too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaDescriptionTooShortInfo, Integer, Hash)>) —

    MetaDescriptionTooShortInfo data, response status code and response headers



6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 6969

def sites_site_id_seov2_issues_meta_desc_short_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_short/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionTooShortInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_short_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_short_get(site_id, opts = {}) ⇒ MetaDescriptionValueList

Get meta description too short issue Get all pages with meta description that are too short

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



7027
7028
7029
7030
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7027

def sites_site_id_seov2_issues_meta_desc_short_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_short_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_short_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaDescriptionValueList, Integer, Hash)>

Get meta description too short issue Get all pages with meta description that are too short

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaDescriptionValueList, Integer, Hash)>) —

    MetaDescriptionValueList data, response status code and response headers



7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7041

def sites_site_id_seov2_issues_meta_desc_short_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_short'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaDescriptionValueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_short_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_desc_short_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta description too short issue Get historical occurrences of meta description too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7113
7114
7115
7116
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7113

def sites_site_id_seov2_issues_meta_desc_short_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_desc_short_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_desc_short_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta description too short issue Get historical occurrences of meta description too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7126

def sites_site_id_seov2_issues_meta_desc_short_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_desc_short/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_desc_short_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_desc_short_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_empty_details_get(site_id, opts = {}) ⇒ MetaTitleEmptyInfo

Get overall stats for meta title empty issue Get overall stats for meta title empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



7195
7196
7197
7198
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7195

def sites_site_id_seov2_issues_meta_title_empty_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_empty_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_empty_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleEmptyInfo, Integer, Hash)>

Get overall stats for meta title empty issue Get overall stats for meta title empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaTitleEmptyInfo, Integer, Hash)>) —

    MetaTitleEmptyInfo data, response status code and response headers



7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7206

def sites_site_id_seov2_issues_meta_title_empty_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_empty/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleEmptyInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_empty_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_empty_get(site_id, opts = {}) ⇒ MetaTitlePageList

Get meta title empty issue Get all pages with an empty meta title

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



7264
7265
7266
7267
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7264

def sites_site_id_seov2_issues_meta_title_empty_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_empty_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_empty_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitlePageList, Integer, Hash)>

Get meta title empty issue Get all pages with an empty meta title

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaTitlePageList, Integer, Hash)>) —

    MetaTitlePageList data, response status code and response headers



7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7278

def sites_site_id_seov2_issues_meta_title_empty_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_empty'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitlePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_empty_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_empty_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta title empty issue Get historical occurrences of meta title empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7350
7351
7352
7353
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7350

def sites_site_id_seov2_issues_meta_title_empty_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_empty_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_empty_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta title empty issue Get historical occurrences of meta title empty issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7363

def sites_site_id_seov2_issues_meta_title_empty_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_empty/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_empty_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_empty_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_long_details_get(site_id, opts = {}) ⇒ MetaTitleTooLongInfo

Get overall stats for meta title too long issue Get overall stats for meta title too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



7432
7433
7434
7435
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7432

def sites_site_id_seov2_issues_meta_title_long_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_long_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_long_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleTooLongInfo, Integer, Hash)>

Get overall stats for meta title too long issue Get overall stats for meta title too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaTitleTooLongInfo, Integer, Hash)>) —

    MetaTitleTooLongInfo data, response status code and response headers



7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7443

def sites_site_id_seov2_issues_meta_title_long_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_long_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_long/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleTooLongInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_long_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_long_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_long_get(site_id, opts = {}) ⇒ MetaTitleValueList

Get meta title too long issue Get all pages with a meta title that is too long

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



7501
7502
7503
7504
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7501

def sites_site_id_seov2_issues_meta_title_long_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_long_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_long_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleValueList, Integer, Hash)>

Get meta title too long issue Get all pages with a meta title that is too long

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaTitleValueList, Integer, Hash)>) —

    MetaTitleValueList data, response status code and response headers



7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7515

def sites_site_id_seov2_issues_meta_title_long_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_long_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_long'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleValueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_long_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_long_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_long_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta title too long issue Get historical occurrences of meta title too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7587
7588
7589
7590
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7587

def sites_site_id_seov2_issues_meta_title_long_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_long_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_long_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta title too long issue Get historical occurrences of meta title too long issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7600

def sites_site_id_seov2_issues_meta_title_long_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_long_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_long_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_long/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_long_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_long_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_missing_details_get(site_id, opts = {}) ⇒ MetaTitleMissingInfo

Get overall stats for meta title missing issue Get overall stats for meta title missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



7669
7670
7671
7672
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7669

def sites_site_id_seov2_issues_meta_title_missing_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_missing_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_missing_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleMissingInfo, Integer, Hash)>

Get overall stats for meta title missing issue Get overall stats for meta title missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaTitleMissingInfo, Integer, Hash)>) —

    MetaTitleMissingInfo data, response status code and response headers



7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7680

def sites_site_id_seov2_issues_meta_title_missing_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_missing/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleMissingInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_missing_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_missing_get(site_id, opts = {}) ⇒ MetaTitlePageList

Get meta title missing issue Get all pages with a missing meta title

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



7738
7739
7740
7741
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7738

def sites_site_id_seov2_issues_meta_title_missing_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_missing_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_missing_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitlePageList, Integer, Hash)>

Get meta title missing issue Get all pages with a missing meta title

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaTitlePageList, Integer, Hash)>) —

    MetaTitlePageList data, response status code and response headers



7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7752

def sites_site_id_seov2_issues_meta_title_missing_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_missing'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitlePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_missing_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_missing_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta title missing issue Get historical occurrences of meta title missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7824
7825
7826
7827
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7824

def sites_site_id_seov2_issues_meta_title_missing_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_missing_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_missing_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta title missing issue Get historical occurrences of meta title missing issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7837

def sites_site_id_seov2_issues_meta_title_missing_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_missing/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_missing_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_missing_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_multiple_details_get(site_id, opts = {}) ⇒ MetaTitleMultipleInfo

Get overall stats for multiple meta title issue Get overall stats for multiple meta title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



7906
7907
7908
7909
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7906

def sites_site_id_seov2_issues_meta_title_multiple_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_multiple_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_multiple_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleMultipleInfo, Integer, Hash)>

Get overall stats for multiple meta title issue Get overall stats for multiple meta title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaTitleMultipleInfo, Integer, Hash)>) —

    MetaTitleMultipleInfo data, response status code and response headers



7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7917

def sites_site_id_seov2_issues_meta_title_multiple_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_multiple/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleMultipleInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_multiple_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_multiple_get(site_id, opts = {}) ⇒ MultipleMetaTitlePageList

Get multiple meta title issue Get all pages with multiple meta titles

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



7976
7977
7978
7979
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7976

def sites_site_id_seov2_issues_meta_title_multiple_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_multiple_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_multiple_get_with_http_info(site_id, opts = {}) ⇒ Array<(MultipleMetaTitlePageList, Integer, Hash)>

Get multiple meta title issue Get all pages with multiple meta titles

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(MultipleMetaTitlePageList, Integer, Hash)>) —

    MultipleMetaTitlePageList data, response status code and response headers



7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 7991

def sites_site_id_seov2_issues_meta_title_multiple_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_multiple'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MultipleMetaTitlePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_multiple_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_multiple_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences for multiple meta title issue Get historical occurrences for multiple meta title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8068
8069
8070
8071
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8068

def sites_site_id_seov2_issues_meta_title_multiple_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_multiple_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_multiple_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences for multiple meta title issue Get historical occurrences for multiple meta title issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8081

def sites_site_id_seov2_issues_meta_title_multiple_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_multiple/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_multiple_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_multiple_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_short_details_get(site_id, opts = {}) ⇒ MetaTitleTooShortInfo

Get overall stats for meta title too short issue Get overall stats for meta title too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



8150
8151
8152
8153
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8150

def sites_site_id_seov2_issues_meta_title_short_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_short_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_short_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleTooShortInfo, Integer, Hash)>

Get overall stats for meta title too short issue Get overall stats for meta title too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MetaTitleTooShortInfo, Integer, Hash)>) —

    MetaTitleTooShortInfo data, response status code and response headers



8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8161

def sites_site_id_seov2_issues_meta_title_short_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_short_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_short/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleTooShortInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_short_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_short_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_short_get(site_id, opts = {}) ⇒ MetaTitleValueList

Get meta title too short issue Get all pages with meta titles that are too short

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



8219
8220
8221
8222
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8219

def sites_site_id_seov2_issues_meta_title_short_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_short_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_short_get_with_http_info(site_id, opts = {}) ⇒ Array<(MetaTitleValueList, Integer, Hash)>

Get meta title too short issue Get all pages with meta titles that are too short

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(MetaTitleValueList, Integer, Hash)>) —

    MetaTitleValueList data, response status code and response headers



8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8233

def sites_site_id_seov2_issues_meta_title_short_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_short_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_short'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaTitleValueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_short_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_short_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_meta_title_short_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of meta title too short issue Get historical occurrences of meta title too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8305
8306
8307
8308
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8305

def sites_site_id_seov2_issues_meta_title_short_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_meta_title_short_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_meta_title_short_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of meta title too short issue Get historical occurrences of meta title too short issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8318

def sites_site_id_seov2_issues_meta_title_short_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_meta_title_short_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_meta_title_short_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/meta_title_short/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_meta_title_short_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_meta_title_short_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_missing_h1_details_get(site_id, opts = {}) ⇒ H1MissingInfo

Get overall stats for missing h1 issue Get overall stats for missing h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



8387
8388
8389
8390
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8387

def sites_site_id_seov2_issues_missing_h1_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_missing_h1_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_missing_h1_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(H1MissingInfo, Integer, Hash)>

Get overall stats for missing h1 issue Get overall stats for missing h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(H1MissingInfo, Integer, Hash)>) —

    H1MissingInfo data, response status code and response headers



8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8398

def sites_site_id_seov2_issues_missing_h1_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_missing_h1_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/missing_h1/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'H1MissingInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_missing_h1_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_missing_h1_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_missing_h1_get(site_id, opts = {}) ⇒ H1IssuePageList

Get missing h1 issue Get all pages without a h1

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



8457
8458
8459
8460
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8457

def sites_site_id_seov2_issues_missing_h1_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_missing_h1_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_missing_h1_get_with_http_info(site_id, opts = {}) ⇒ Array<(H1IssuePageList, Integer, Hash)>

Get missing h1 issue Get all pages without a h1

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(H1IssuePageList, Integer, Hash)>) —

    H1IssuePageList data, response status code and response headers



8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8472

def sites_site_id_seov2_issues_missing_h1_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_missing_h1_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/missing_h1'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'H1IssuePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_missing_h1_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_missing_h1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_missing_h1_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of missing h1 issue Get historical occurrences of missing h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8549
8550
8551
8552
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8549

def sites_site_id_seov2_issues_missing_h1_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_missing_h1_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_missing_h1_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of missing h1 issue Get historical occurrences of missing h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8562

def sites_site_id_seov2_issues_missing_h1_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_missing_h1_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_missing_h1_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/missing_h1/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_missing_h1_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_missing_h1_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_missing_robots_details_get(site_id, opts = {}) ⇒ RobotsTxtExist

Get missing robots issue Get missing robots issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8630
8631
8632
8633
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8630

def sites_site_id_seov2_issues_missing_robots_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_missing_robots_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_missing_robots_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(RobotsTxtExist, Integer, Hash)>

Get missing robots issue Get missing robots issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RobotsTxtExist, Integer, Hash)>) —

    RobotsTxtExist data, response status code and response headers



8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8640

def sites_site_id_seov2_issues_missing_robots_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_missing_robots_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_missing_robots_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/missing_robots/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RobotsTxtExist'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_missing_robots_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_missing_robots_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_missing_sitemap_details_get(site_id, opts = {}) ⇒ SitemapExist

Get missing sitemap issue Get missing sitemap issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8693
8694
8695
8696
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8693

def sites_site_id_seov2_issues_missing_sitemap_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_missing_sitemap_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_missing_sitemap_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(SitemapExist, Integer, Hash)>

Get missing sitemap issue Get missing sitemap issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SitemapExist, Integer, Hash)>) —

    SitemapExist data, response status code and response headers



8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8703

def sites_site_id_seov2_issues_missing_sitemap_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_missing_sitemap_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_missing_sitemap_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/missing_sitemap/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SitemapExist'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_missing_sitemap_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_missing_sitemap_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_misspelling_entry_pages_details_get(site_id, opts = {}) ⇒ MisspellingsInfo

Get overall stats for misspellings on entry pages issue Get overall stats for misspellings on entry pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



8757
8758
8759
8760
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8757

def sites_site_id_seov2_issues_misspelling_entry_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_misspelling_entry_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_misspelling_entry_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MisspellingsInfo, Integer, Hash)>

Get overall stats for misspellings on entry pages issue Get overall stats for misspellings on entry pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MisspellingsInfo, Integer, Hash)>) —

    MisspellingsInfo data, response status code and response headers



8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8768

def sites_site_id_seov2_issues_misspelling_entry_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/misspelling_entry_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MisspellingsInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_misspelling_entry_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_misspelling_entry_pages_get(site_id, opts = {}) ⇒ MisspellingList

Get misspellings on entry pages issue Get all entry pages with a misspelling

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8825
8826
8827
8828
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8825

def sites_site_id_seov2_issues_misspelling_entry_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_misspelling_entry_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_misspelling_entry_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(MisspellingList, Integer, Hash)>

Get misspellings on entry pages issue Get all entry pages with a misspelling

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(MisspellingList, Integer, Hash)>) —

    MisspellingList data, response status code and response headers



8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8838

def sites_site_id_seov2_issues_misspelling_entry_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/misspelling_entry_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MisspellingList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_misspelling_entry_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_misspelling_entry_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of misspelling on entry pages issue Get historical occurrences of misspelling on entry pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8909
8910
8911
8912
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8909

def sites_site_id_seov2_issues_misspelling_entry_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_misspelling_entry_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_misspelling_entry_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of misspelling on entry pages issue Get historical occurrences of misspelling on entry pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8922

def sites_site_id_seov2_issues_misspelling_entry_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/misspelling_entry_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_misspelling_entry_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_misspelling_entry_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_misspellings_details_get(site_id, opts = {}) ⇒ MisspellingsInfo

Get overall stats for misspellings issue Get overall stats for misspellings issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



8991
8992
8993
8994
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 8991

def sites_site_id_seov2_issues_misspellings_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_misspellings_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_misspellings_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MisspellingsInfo, Integer, Hash)>

Get overall stats for misspellings issue Get overall stats for misspellings issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(MisspellingsInfo, Integer, Hash)>) —

    MisspellingsInfo data, response status code and response headers



9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9002

def sites_site_id_seov2_issues_misspellings_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_misspellings_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/misspellings/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MisspellingsInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_misspellings_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_misspellings_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_misspellings_get(site_id, opts = {}) ⇒ MisspellingList

Get misspellings issue Get all misspellings found on the website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9059
9060
9061
9062
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9059

def sites_site_id_seov2_issues_misspellings_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_misspellings_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_misspellings_get_with_http_info(site_id, opts = {}) ⇒ Array<(MisspellingList, Integer, Hash)>

Get misspellings issue Get all misspellings found on the website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(MisspellingList, Integer, Hash)>) —

    MisspellingList data, response status code and response headers



9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9072

def sites_site_id_seov2_issues_misspellings_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_misspellings_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/misspellings'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MisspellingList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_misspellings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_misspellings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_misspellings_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of misspelling issue Get historical occurrences of misspelling issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9143
9144
9145
9146
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9143

def sites_site_id_seov2_issues_misspellings_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_misspellings_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_misspellings_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of misspelling issue Get historical occurrences of misspelling issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9156

def sites_site_id_seov2_issues_misspellings_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_misspellings_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_misspellings_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/misspellings/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_misspellings_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_misspellings_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_mobile_friendly_details_get(site_id, opts = {}) ⇒ MobileFriendly

Get mobile friendly issue Get mobile friendly issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9224
9225
9226
9227
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9224

def sites_site_id_seov2_issues_mobile_friendly_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_mobile_friendly_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_mobile_friendly_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MobileFriendly, Integer, Hash)>

Get mobile friendly issue Get mobile friendly issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MobileFriendly, Integer, Hash)>) —

    MobileFriendly data, response status code and response headers



9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9234

def sites_site_id_seov2_issues_mobile_friendly_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_mobile_friendly_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_mobile_friendly_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/mobile_friendly/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MobileFriendly'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_mobile_friendly_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_mobile_friendly_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_mobile_speed_details_get(site_id, opts = {}) ⇒ MobileSpeed

Get mobile speed issue Get mobile speed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9287
9288
9289
9290
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9287

def sites_site_id_seov2_issues_mobile_speed_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_mobile_speed_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_mobile_speed_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MobileSpeed, Integer, Hash)>

Get mobile speed issue Get mobile speed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MobileSpeed, Integer, Hash)>) —

    MobileSpeed data, response status code and response headers



9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9297

def sites_site_id_seov2_issues_mobile_speed_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_mobile_speed_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_mobile_speed_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/mobile_speed/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MobileSpeed'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_mobile_speed_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_mobile_speed_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_mobile_speed_history_get(site_id, opts = {}) ⇒ MobileSpeedHistoryItemList

Get the mobile speed score historically Get the mobile speed score historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9353
9354
9355
9356
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9353

def sites_site_id_seov2_issues_mobile_speed_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_mobile_speed_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_mobile_speed_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(MobileSpeedHistoryItemList, Integer, Hash)>

Get the mobile speed score historically Get the mobile speed score historically

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(MobileSpeedHistoryItemList, Integer, Hash)>) —

    MobileSpeedHistoryItemList data, response status code and response headers



9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9366

def sites_site_id_seov2_issues_mobile_speed_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_mobile_speed_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_mobile_speed_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_mobile_speed_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_mobile_speed_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_mobile_speed_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/mobile_speed/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MobileSpeedHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_mobile_speed_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_mobile_speed_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_mobile_viewport_details_get(site_id, opts = {}) ⇒ MobileViewport

Get mobile viewport issue Get mobile viewport issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9434
9435
9436
9437
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9434

def sites_site_id_seov2_issues_mobile_viewport_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_mobile_viewport_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_mobile_viewport_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(MobileViewport, Integer, Hash)>

Get mobile viewport issue Get mobile viewport issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MobileViewport, Integer, Hash)>) —

    MobileViewport data, response status code and response headers



9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9444

def sites_site_id_seov2_issues_mobile_viewport_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_mobile_viewport_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_mobile_viewport_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/mobile_viewport/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MobileViewport'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_mobile_viewport_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_mobile_viewport_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_multiple_h1_details_get(site_id, opts = {}) ⇒ H1MultipleInfo

Get overall stats for multiple h1 issue Get overall stats for multiple h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



9498
9499
9500
9501
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9498

def sites_site_id_seov2_issues_multiple_h1_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_multiple_h1_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_multiple_h1_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(H1MultipleInfo, Integer, Hash)>

Get overall stats for multiple h1 issue Get overall stats for multiple h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(H1MultipleInfo, Integer, Hash)>) —

    H1MultipleInfo data, response status code and response headers



9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9509

def sites_site_id_seov2_issues_multiple_h1_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_multiple_h1_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/multiple_h1/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'H1MultipleInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_multiple_h1_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_multiple_h1_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_multiple_h1_get(site_id, opts = {}) ⇒ H1IssuePageList

Get multiple h1 issue Get all pages with multiple h1s

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



9568
9569
9570
9571
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9568

def sites_site_id_seov2_issues_multiple_h1_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_multiple_h1_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_multiple_h1_get_with_http_info(site_id, opts = {}) ⇒ Array<(H1IssuePageList, Integer, Hash)>

Get multiple h1 issue Get all pages with multiple h1s

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(H1IssuePageList, Integer, Hash)>) —

    H1IssuePageList data, response status code and response headers



9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9583

def sites_site_id_seov2_issues_multiple_h1_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_multiple_h1_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/multiple_h1'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'H1IssuePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_multiple_h1_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_multiple_h1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_multiple_h1_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences for multiple h1 issue Get historical occurrences for multiple h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9660
9661
9662
9663
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9660

def sites_site_id_seov2_issues_multiple_h1_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_multiple_h1_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_multiple_h1_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences for multiple h1 issue Get historical occurrences for multiple h1 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9673

def sites_site_id_seov2_issues_multiple_h1_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_multiple_h1_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_multiple_h1_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/multiple_h1/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_multiple_h1_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_multiple_h1_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_navigation_depth_details_get(site_id, opts = {}) ⇒ PagesWithHighNavigationDepthInfo

Get overall stats for navigation depth issue Get overall stats for navigation depth issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



9742
9743
9744
9745
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9742

def sites_site_id_seov2_issues_navigation_depth_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_navigation_depth_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_navigation_depth_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithHighNavigationDepthInfo, Integer, Hash)>

Get overall stats for navigation depth issue Get overall stats for navigation depth issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9753

def sites_site_id_seov2_issues_navigation_depth_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_navigation_depth_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/navigation_depth/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithHighNavigationDepthInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_navigation_depth_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_navigation_depth_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_navigation_depth_get(site_id, opts = {}) ⇒ PageWithHighNavigationDepthList

Get navigation depth issue Get all pages with high navigation depth

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



9812
9813
9814
9815
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9812

def sites_site_id_seov2_issues_navigation_depth_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_navigation_depth_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_navigation_depth_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithHighNavigationDepthList, Integer, Hash)>

Get navigation depth issue Get all pages with high navigation depth

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9827

def sites_site_id_seov2_issues_navigation_depth_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_navigation_depth_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/navigation_depth'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithHighNavigationDepthList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_navigation_depth_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_navigation_depth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_navigation_depth_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of navigation depth issue Get historical occurrences of navigation depth issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9904
9905
9906
9907
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9904

def sites_site_id_seov2_issues_navigation_depth_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_navigation_depth_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_navigation_depth_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of navigation depth issue Get historical occurrences of navigation depth issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9917

def sites_site_id_seov2_issues_navigation_depth_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_navigation_depth_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_navigation_depth_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/navigation_depth/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_navigation_depth_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_navigation_depth_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_new_pages_details_get(site_id, opts = {}) ⇒ NewPagesInfo

Get new pages issue Get new pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



9986
9987
9988
9989
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9986

def sites_site_id_seov2_issues_new_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_new_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_new_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(NewPagesInfo, Integer, Hash)>

Get new pages issue Get new pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(NewPagesInfo, Integer, Hash)>) —

    NewPagesInfo data, response status code and response headers



9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 9997

def sites_site_id_seov2_issues_new_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_new_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_new_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/new_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NewPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_new_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_new_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_new_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of new pages issue Get historical occurrences of new pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10054
10055
10056
10057
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10054

def sites_site_id_seov2_issues_new_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_new_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_new_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of new pages issue Get historical occurrences of new pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10067

def sites_site_id_seov2_issues_new_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_new_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_new_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_new_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_new_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_new_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/new_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_new_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_new_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_nofollow_pages_details_get(site_id, opts = {}) ⇒ NoFollowPagesInfo

Get overall stats for nofollow pages issue Get overall stats for nofollow pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



10136
10137
10138
10139
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10136

def sites_site_id_seov2_issues_nofollow_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_nofollow_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_nofollow_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(NoFollowPagesInfo, Integer, Hash)>

Get overall stats for nofollow pages issue Get overall stats for nofollow pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(NoFollowPagesInfo, Integer, Hash)>) —

    NoFollowPagesInfo data, response status code and response headers



10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10147

def sites_site_id_seov2_issues_nofollow_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/nofollow_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NoFollowPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_nofollow_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_nofollow_pages_get(site_id, opts = {}) ⇒ NoFollowPageList

Get nofollow pages issue Get all pages with a nofollow tag

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



10206
10207
10208
10209
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10206

def sites_site_id_seov2_issues_nofollow_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_nofollow_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_nofollow_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(NoFollowPageList, Integer, Hash)>

Get nofollow pages issue Get all pages with a nofollow tag

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(NoFollowPageList, Integer, Hash)>) —

    NoFollowPageList data, response status code and response headers



10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10221

def sites_site_id_seov2_issues_nofollow_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/nofollow_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NoFollowPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_nofollow_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_nofollow_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of nofollow pages issue Get historical occurrences of nofollow pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10298
10299
10300
10301
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10298

def sites_site_id_seov2_issues_nofollow_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_nofollow_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_nofollow_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of nofollow pages issue Get historical occurrences of nofollow pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10311

def sites_site_id_seov2_issues_nofollow_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/nofollow_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_nofollow_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_nofollow_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_noindex_pages_details_get(site_id, opts = {}) ⇒ NoIndexPagesInfo

Get overall stats for noindex pages issue Get overall stats for noindex pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



10380
10381
10382
10383
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10380

def sites_site_id_seov2_issues_noindex_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_noindex_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_noindex_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(NoIndexPagesInfo, Integer, Hash)>

Get overall stats for noindex pages issue Get overall stats for noindex pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(NoIndexPagesInfo, Integer, Hash)>) —

    NoIndexPagesInfo data, response status code and response headers



10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10391

def sites_site_id_seov2_issues_noindex_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_noindex_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/noindex_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NoIndexPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_noindex_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_noindex_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_noindex_pages_get(site_id, opts = {}) ⇒ NoIndexPageList

Get noindex pages Get all pages with a noindex tag

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



10450
10451
10452
10453
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10450

def sites_site_id_seov2_issues_noindex_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_noindex_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_noindex_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(NoIndexPageList, Integer, Hash)>

Get noindex pages Get all pages with a noindex tag

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(NoIndexPageList, Integer, Hash)>) —

    NoIndexPageList data, response status code and response headers



10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10465

def sites_site_id_seov2_issues_noindex_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_noindex_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/noindex_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NoIndexPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_noindex_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_noindex_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_noindex_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of noindex pages issue Get historical occurrences of noindex pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10542
10543
10544
10545
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10542

def sites_site_id_seov2_issues_noindex_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_noindex_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_noindex_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of noindex pages issue Get historical occurrences of noindex pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10555

def sites_site_id_seov2_issues_noindex_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_noindex_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_noindex_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/noindex_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_noindex_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_noindex_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_open_graph_tag_pages_details_get(site_id, opts = {}) ⇒ OpenGraphTagsPagesInfo

Get overall stats for open graph tag pages issue Get overall stats for open graph tag pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



10624
10625
10626
10627
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10624

def sites_site_id_seov2_issues_open_graph_tag_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_open_graph_tag_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_open_graph_tag_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(OpenGraphTagsPagesInfo, Integer, Hash)>

Get overall stats for open graph tag pages issue Get overall stats for open graph tag pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(OpenGraphTagsPagesInfo, Integer, Hash)>) —

    OpenGraphTagsPagesInfo data, response status code and response headers



10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10635

def sites_site_id_seov2_issues_open_graph_tag_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/open_graph_tag_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OpenGraphTagsPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_open_graph_tag_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_open_graph_tag_pages_get(site_id, opts = {}) ⇒ OpenGraphTagsPageList

Get open graph tag pages issue Get all pages without open graph tags

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



10694
10695
10696
10697
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10694

def sites_site_id_seov2_issues_open_graph_tag_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_open_graph_tag_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_open_graph_tag_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(OpenGraphTagsPageList, Integer, Hash)>

Get open graph tag pages issue Get all pages without open graph tags

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(OpenGraphTagsPageList, Integer, Hash)>) —

    OpenGraphTagsPageList data, response status code and response headers



10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10709

def sites_site_id_seov2_issues_open_graph_tag_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/open_graph_tag_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OpenGraphTagsPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_open_graph_tag_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_open_graph_tag_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of open graph tag pages issue Get historical occurrences of open graph tag pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10786
10787
10788
10789
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10786

def sites_site_id_seov2_issues_open_graph_tag_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_open_graph_tag_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_open_graph_tag_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of open graph tag pages issue Get historical occurrences of open graph tag pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10799

def sites_site_id_seov2_issues_open_graph_tag_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/open_graph_tag_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_open_graph_tag_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_open_graph_tag_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_page_size_details_get(site_id, opts = {}) ⇒ PageSizeInfo

Get overall stats for page size issue Get overall stats for page size issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



10868
10869
10870
10871
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10868

def sites_site_id_seov2_issues_page_size_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_page_size_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_page_size_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageSizeInfo, Integer, Hash)>

Get overall stats for page size issue Get overall stats for page size issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PageSizeInfo, Integer, Hash)>) —

    PageSizeInfo data, response status code and response headers



10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10879

def sites_site_id_seov2_issues_page_size_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_page_size_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_page_size_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/page_size/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageSizeInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_page_size_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_page_size_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_page_size_get(site_id, opts = {}) ⇒ PageTooLargeList

Get page size issue Get all pages with a size over 1 mb

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



10938
10939
10940
10941
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10938

def sites_site_id_seov2_issues_page_size_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_page_size_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_page_size_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageTooLargeList, Integer, Hash)>

Get page size issue Get all pages with a size over 1 mb

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageTooLargeList, Integer, Hash)>) —

    PageTooLargeList data, response status code and response headers



10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 10953

def sites_site_id_seov2_issues_page_size_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_page_size_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_page_size_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_page_size_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_page_size_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_page_size_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/page_size'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageTooLargeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_page_size_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_page_size_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_page_size_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of page size issue Get historical occurrences of page size issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11030
11031
11032
11033
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11030

def sites_site_id_seov2_issues_page_size_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_page_size_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_page_size_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of page size issue Get historical occurrences of page size issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11043

def sites_site_id_seov2_issues_page_size_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_page_size_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_page_size_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_page_size_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_page_size_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_page_size_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/page_size/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_page_size_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_page_size_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_broken_links_details_get(site_id, opts = {}) ⇒ PagesWithBrokenSeoLinksInfo

Get overall stats for pages with broken links issue Get overall stats for pages with broken links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



11112
11113
11114
11115
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11112

def sites_site_id_seov2_issues_pages_with_broken_links_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_broken_links_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_broken_links_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithBrokenSeoLinksInfo, Integer, Hash)>

Get overall stats for pages with broken links issue Get overall stats for pages with broken links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesWithBrokenSeoLinksInfo, Integer, Hash)>) —

    PagesWithBrokenSeoLinksInfo data, response status code and response headers



11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11123

def sites_site_id_seov2_issues_pages_with_broken_links_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_broken_links/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithBrokenSeoLinksInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_broken_links_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_broken_links_get(site_id, opts = {}) ⇒ PageWithBrokenSeoLinkList

Get pages with broken links issue Get all pages with a broken link

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



11182
11183
11184
11185
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11182

def sites_site_id_seov2_issues_pages_with_broken_links_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_broken_links_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_broken_links_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithBrokenSeoLinkList, Integer, Hash)>

Get pages with broken links issue Get all pages with a broken link

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageWithBrokenSeoLinkList, Integer, Hash)>) —

    PageWithBrokenSeoLinkList data, response status code and response headers



11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11197

def sites_site_id_seov2_issues_pages_with_broken_links_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_broken_links'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithBrokenSeoLinkList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_broken_links_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_broken_links_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of page with broken links issue Get historical occurrences of page with broken links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11274
11275
11276
11277
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11274

def sites_site_id_seov2_issues_pages_with_broken_links_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_broken_links_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_broken_links_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of page with broken links issue Get historical occurrences of page with broken links issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11287

def sites_site_id_seov2_issues_pages_with_broken_links_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_broken_links/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_broken_links_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_broken_links_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_frames_details_get(site_id, opts = {}) ⇒ PagesWithFramesInfo

Get overall stats for pages with frames issue Get overall stats for pages with frames issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



11356
11357
11358
11359
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11356

def sites_site_id_seov2_issues_pages_with_frames_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_frames_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_frames_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithFramesInfo, Integer, Hash)>

Get overall stats for pages with frames issue Get overall stats for pages with frames issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesWithFramesInfo, Integer, Hash)>) —

    PagesWithFramesInfo data, response status code and response headers



11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11367

def sites_site_id_seov2_issues_pages_with_frames_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_frames/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithFramesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_frames_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_frames_get(site_id, opts = {}) ⇒ PageWithFramesList

Get pages with frames issue Get all pages with a frame or iframe

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



11426
11427
11428
11429
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11426

def sites_site_id_seov2_issues_pages_with_frames_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_frames_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_frames_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithFramesList, Integer, Hash)>

Get pages with frames issue Get all pages with a frame or iframe

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageWithFramesList, Integer, Hash)>) —

    PageWithFramesList data, response status code and response headers



11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11441

def sites_site_id_seov2_issues_pages_with_frames_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_frames'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithFramesList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_frames_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_frames_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of page with frames issue Get historical occurrences of page with frames issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11518
11519
11520
11521
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11518

def sites_site_id_seov2_issues_pages_with_frames_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_frames_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_frames_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of page with frames issue Get historical occurrences of page with frames issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11531

def sites_site_id_seov2_issues_pages_with_frames_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_frames/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_frames_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_frames_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_images1mb_details_get(site_id, opts = {}) ⇒ PagesWithImagesLargerThan1MbInfo

Get overall stats for pages with images over 1mb issue Get overall stats for pages with images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



11600
11601
11602
11603
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11600

def sites_site_id_seov2_issues_pages_with_images1mb_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_images1mb_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_images1mb_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithImagesLargerThan1MbInfo, Integer, Hash)>

Get overall stats for pages with images over 1mb issue Get overall stats for pages with images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11611

def sites_site_id_seov2_issues_pages_with_images1mb_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_images_1mb/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithImagesLargerThan1MbInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_images1mb_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_images1mb_get(site_id, opts = {}) ⇒ PageWithImagesLargerThan1MbList

Get pages with images over 1mb issue Get all pages with an image over 1 mb

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



11670
11671
11672
11673
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11670

def sites_site_id_seov2_issues_pages_with_images1mb_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_images1mb_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_images1mb_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithImagesLargerThan1MbList, Integer, Hash)>

Get pages with images over 1mb issue Get all pages with an image over 1 mb

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11685

def sites_site_id_seov2_issues_pages_with_images1mb_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_images_1mb'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithImagesLargerThan1MbList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_images1mb_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_images1mb_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of page with images over 1mb issue Get historical occurrences of page with images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11762
11763
11764
11765
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11762

def sites_site_id_seov2_issues_pages_with_images1mb_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_images1mb_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_images1mb_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of page with images over 1mb issue Get historical occurrences of page with images over 1mb issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11775

def sites_site_id_seov2_issues_pages_with_images1mb_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_images_1mb/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_images1mb_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_images1mb_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_misspellings_details_get(site_id, opts = {}) ⇒ PagesWithMisspellingInfo

Get overall stats for pages with misspellings issue Get overall stats for pages with misspellings issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



11844
11845
11846
11847
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11844

def sites_site_id_seov2_issues_pages_with_misspellings_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_misspellings_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_misspellings_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithMisspellingInfo, Integer, Hash)>

Get overall stats for pages with misspellings issue Get overall stats for pages with misspellings issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesWithMisspellingInfo, Integer, Hash)>) —

    PagesWithMisspellingInfo data, response status code and response headers



11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11855

def sites_site_id_seov2_issues_pages_with_misspellings_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_misspellings/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithMisspellingInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_misspellings_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_misspellings_get(site_id, opts = {}) ⇒ PageWithMisspellingList

Get pages with misspellings issue Get all pages with a misspelling

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



11914
11915
11916
11917
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11914

def sites_site_id_seov2_issues_pages_with_misspellings_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_misspellings_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_misspellings_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithMisspellingList, Integer, Hash)>

Get pages with misspellings issue Get all pages with a misspelling

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageWithMisspellingList, Integer, Hash)>) —

    PageWithMisspellingList data, response status code and response headers



11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 11929

def sites_site_id_seov2_issues_pages_with_misspellings_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_misspellings'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithMisspellingList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_misspellings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_pages_with_misspellings_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of page with misspellings issue Get historical occurrences of page with misspellings issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12006
12007
12008
12009
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12006

def sites_site_id_seov2_issues_pages_with_misspellings_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_pages_with_misspellings_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_pages_with_misspellings_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of page with misspellings issue Get historical occurrences of page with misspellings issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12019

def sites_site_id_seov2_issues_pages_with_misspellings_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/pages_with_misspellings/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_pages_with_misspellings_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_pages_with_misspellings_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_parameterized_urls_details_get(site_id, opts = {}) ⇒ PagesWithParametersInfo

Get overall stats for parameterized urls issue Get overall stats for parameterized urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



12088
12089
12090
12091
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12088

def sites_site_id_seov2_issues_parameterized_urls_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_parameterized_urls_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_parameterized_urls_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesWithParametersInfo, Integer, Hash)>

Get overall stats for parameterized urls issue Get overall stats for parameterized urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesWithParametersInfo, Integer, Hash)>) —

    PagesWithParametersInfo data, response status code and response headers



12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12099

def sites_site_id_seov2_issues_parameterized_urls_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/parameterized_urls/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesWithParametersInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_parameterized_urls_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_parameterized_urls_get(site_id, opts = {}) ⇒ PageWithParameterList

Get parameterized urls issue Get all pages with a parameterized url

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



12158
12159
12160
12161
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12158

def sites_site_id_seov2_issues_parameterized_urls_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_parameterized_urls_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_parameterized_urls_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithParameterList, Integer, Hash)>

Get parameterized urls issue Get all pages with a parameterized url

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageWithParameterList, Integer, Hash)>) —

    PageWithParameterList data, response status code and response headers



12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12173

def sites_site_id_seov2_issues_parameterized_urls_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/parameterized_urls'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithParameterList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_parameterized_urls_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_parameterized_urls_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of parameterized urls issue Get historical occurrences of parameterized urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12250
12251
12252
12253
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12250

def sites_site_id_seov2_issues_parameterized_urls_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_parameterized_urls_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_parameterized_urls_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of parameterized urls issue Get historical occurrences of parameterized urls issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12263

def sites_site_id_seov2_issues_parameterized_urls_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/parameterized_urls/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_parameterized_urls_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_parameterized_urls_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_readability_pages_score_details_get(site_id, opts = {}) ⇒ ReadabilityScorePagesInfo

Get overall stats for readability page score issue Get overall stats for readability page score issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



12332
12333
12334
12335
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12332

def sites_site_id_seov2_issues_readability_pages_score_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_readability_pages_score_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_readability_pages_score_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(ReadabilityScorePagesInfo, Integer, Hash)>

Get overall stats for readability page score issue Get overall stats for readability page score issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(ReadabilityScorePagesInfo, Integer, Hash)>) —

    ReadabilityScorePagesInfo data, response status code and response headers



12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12343

def sites_site_id_seov2_issues_readability_pages_score_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/readability_pages_score/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ReadabilityScorePagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_readability_pages_score_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_readability_pages_score_get(site_id, opts = {}) ⇒ ReadabilityScorePageList

Get readability pages score issue Get all pages with a readability score less than 70

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



12402
12403
12404
12405
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12402

def sites_site_id_seov2_issues_readability_pages_score_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_readability_pages_score_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_readability_pages_score_get_with_http_info(site_id, opts = {}) ⇒ Array<(ReadabilityScorePageList, Integer, Hash)>

Get readability pages score issue Get all pages with a readability score less than 70

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(ReadabilityScorePageList, Integer, Hash)>) —

    ReadabilityScorePageList data, response status code and response headers



12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12417

def sites_site_id_seov2_issues_readability_pages_score_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/readability_pages_score'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ReadabilityScorePageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_readability_pages_score_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_readability_pages_score_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of readability pages score issue Get historical occurrences of readability pages score issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12494
12495
12496
12497
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12494

def sites_site_id_seov2_issues_readability_pages_score_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_readability_pages_score_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_readability_pages_score_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of readability pages score issue Get historical occurrences of readability pages score issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12507

def sites_site_id_seov2_issues_readability_pages_score_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/readability_pages_score/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_readability_pages_score_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_readability_pages_score_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect301_details_get(site_id, opts = {}) ⇒ Redirect301PagesInfo

Get overall stats for redirect 301 issue Get overall stats for redirect 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



12576
12577
12578
12579
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12576

def sites_site_id_seov2_issues_redirect301_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect301_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect301_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(Redirect301PagesInfo, Integer, Hash)>

Get overall stats for redirect 301 issue Get overall stats for redirect 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(Redirect301PagesInfo, Integer, Hash)>) —

    Redirect301PagesInfo data, response status code and response headers



12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12587

def sites_site_id_seov2_issues_redirect301_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect301_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_301/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Redirect301PagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect301_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect301_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect301_get(site_id, opts = {}) ⇒ Redirect301PageList

Get redirect 301 issue Get all pages with a 301 redirect

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



12645
12646
12647
12648
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12645

def sites_site_id_seov2_issues_redirect301_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect301_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect301_get_with_http_info(site_id, opts = {}) ⇒ Array<(Redirect301PageList, Integer, Hash)>

Get redirect 301 issue Get all pages with a 301 redirect

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(Redirect301PageList, Integer, Hash)>) —

    Redirect301PageList data, response status code and response headers



12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12659

def sites_site_id_seov2_issues_redirect301_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect301_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_301'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Redirect301PageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect301_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect301_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect301_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of redirect 301 issue Get historical occurrences of redirect 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12731
12732
12733
12734
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12731

def sites_site_id_seov2_issues_redirect301_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect301_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect301_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of redirect 301 issue Get historical occurrences of redirect 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12744

def sites_site_id_seov2_issues_redirect301_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect301_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect301_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_301/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect301_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect301_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_chain_details_get(site_id, opts = {}) ⇒ RedirectChainPagesInfo

Get overall stats for redirect chain issue Get overall stats for redirect chain issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



12813
12814
12815
12816
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12813

def sites_site_id_seov2_issues_redirect_chain_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_chain_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_chain_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(RedirectChainPagesInfo, Integer, Hash)>

Get overall stats for redirect chain issue Get overall stats for redirect chain issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(RedirectChainPagesInfo, Integer, Hash)>) —

    RedirectChainPagesInfo data, response status code and response headers



12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12824

def sites_site_id_seov2_issues_redirect_chain_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_chain_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_chain/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedirectChainPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_chain_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_chain_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_chain_get(site_id, opts = {}) ⇒ RedirectChainPageList

Get redirect chain issue Get all pages with a redirect chain

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



12882
12883
12884
12885
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12882

def sites_site_id_seov2_issues_redirect_chain_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_chain_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_chain_get_with_http_info(site_id, opts = {}) ⇒ Array<(RedirectChainPageList, Integer, Hash)>

Get redirect chain issue Get all pages with a redirect chain

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(RedirectChainPageList, Integer, Hash)>) —

    RedirectChainPageList data, response status code and response headers



12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12896

def sites_site_id_seov2_issues_redirect_chain_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_chain_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_chain'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedirectChainPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_chain_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_chain_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_chain_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of redirect chain issue Get historical occurrences of redirect chain issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12968
12969
12970
12971
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12968

def sites_site_id_seov2_issues_redirect_chain_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_chain_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_chain_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of redirect chain issue Get historical occurrences of redirect chain issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 12981

def sites_site_id_seov2_issues_redirect_chain_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_chain_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_chain_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_chain/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_chain_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_chain_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_mixed_details_get(site_id, opts = {}) ⇒ RedirectMixedPagesInfo

Get overall stats for redirect mixed issue Get overall stats for redirect mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



13050
13051
13052
13053
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13050

def sites_site_id_seov2_issues_redirect_mixed_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_mixed_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_mixed_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(RedirectMixedPagesInfo, Integer, Hash)>

Get overall stats for redirect mixed issue Get overall stats for redirect mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(RedirectMixedPagesInfo, Integer, Hash)>) —

    RedirectMixedPagesInfo data, response status code and response headers



13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13061

def sites_site_id_seov2_issues_redirect_mixed_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_mixed/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedirectMixedPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_mixed_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_mixed_get(site_id, opts = {}) ⇒ RedirectMixedPageList

Get redirect mixed issue Get all redirect mixed pages

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



13119
13120
13121
13122
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13119

def sites_site_id_seov2_issues_redirect_mixed_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_mixed_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_mixed_get_with_http_info(site_id, opts = {}) ⇒ Array<(RedirectMixedPageList, Integer, Hash)>

Get redirect mixed issue Get all redirect mixed pages

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(RedirectMixedPageList, Integer, Hash)>) —

    RedirectMixedPageList data, response status code and response headers



13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13133

def sites_site_id_seov2_issues_redirect_mixed_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_mixed'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedirectMixedPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_mixed_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_mixed_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of redirect mixed issue Get historical occurrences of redirect mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13205
13206
13207
13208
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13205

def sites_site_id_seov2_issues_redirect_mixed_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_mixed_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_mixed_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of redirect mixed issue Get historical occurrences of redirect mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13218

def sites_site_id_seov2_issues_redirect_mixed_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_mixed/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_mixed_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_mixed_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_not301_details_get(site_id, opts = {}) ⇒ RedirectNot301PagesInfo

Get overall stats for redirect not 301 issue Get overall stats for redirect not 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



13287
13288
13289
13290
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13287

def sites_site_id_seov2_issues_redirect_not301_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_not301_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_not301_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(RedirectNot301PagesInfo, Integer, Hash)>

Get overall stats for redirect not 301 issue Get overall stats for redirect not 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(RedirectNot301PagesInfo, Integer, Hash)>) —

    RedirectNot301PagesInfo data, response status code and response headers



13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13298

def sites_site_id_seov2_issues_redirect_not301_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_not301_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_not_301/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedirectNot301PagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_not301_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_not301_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_not301_get(site_id, opts = {}) ⇒ RedirectNot301PageList

Get redirect not 301 issue Get all pages with a redirect that is not 301

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



13356
13357
13358
13359
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13356

def sites_site_id_seov2_issues_redirect_not301_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_not301_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_not301_get_with_http_info(site_id, opts = {}) ⇒ Array<(RedirectNot301PageList, Integer, Hash)>

Get redirect not 301 issue Get all pages with a redirect that is not 301

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(RedirectNot301PageList, Integer, Hash)>) —

    RedirectNot301PageList data, response status code and response headers



13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13370

def sites_site_id_seov2_issues_redirect_not301_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_not301_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_not_301'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedirectNot301PageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_not301_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_not301_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_redirect_not301_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of redirect not 301 issue Get historical occurrences of redirect not 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13442
13443
13444
13445
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13442

def sites_site_id_seov2_issues_redirect_not301_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_redirect_not301_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_redirect_not301_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of redirect not 301 issue Get historical occurrences of redirect not 301 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13455

def sites_site_id_seov2_issues_redirect_not301_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_redirect_not301_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_redirect_not301_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/redirect_not_301/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_redirect_not301_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_redirect_not301_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_sitemap_excluded_pages_details_get(site_id, opts = {}) ⇒ PagesInSitemapInfo

Get overall stats for sitemap excluded pages issue Get overall stats for sitemap excluded pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



13524
13525
13526
13527
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13524

def sites_site_id_seov2_issues_sitemap_excluded_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_sitemap_excluded_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_sitemap_excluded_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(PagesInSitemapInfo, Integer, Hash)>

Get overall stats for sitemap excluded pages issue Get overall stats for sitemap excluded pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(PagesInSitemapInfo, Integer, Hash)>) —

    PagesInSitemapInfo data, response status code and response headers



13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13535

def sites_site_id_seov2_issues_sitemap_excluded_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/sitemap_excluded_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PagesInSitemapInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_sitemap_excluded_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_sitemap_excluded_pages_get(site_id, opts = {}) ⇒ PageNotInSitemapList

Get sitemap excluded pages issue Get all pages not included in the sitemap

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



13594
13595
13596
13597
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13594

def sites_site_id_seov2_issues_sitemap_excluded_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_sitemap_excluded_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_sitemap_excluded_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageNotInSitemapList, Integer, Hash)>

Get sitemap excluded pages issue Get all pages not included in the sitemap

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(PageNotInSitemapList, Integer, Hash)>) —

    PageNotInSitemapList data, response status code and response headers



13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13609

def sites_site_id_seov2_issues_sitemap_excluded_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/sitemap_excluded_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageNotInSitemapList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_sitemap_excluded_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_sitemap_excluded_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of sitemap excluded pages issue Get historical occurrences of sitemap excluded pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13686
13687
13688
13689
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13686

def sites_site_id_seov2_issues_sitemap_excluded_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_sitemap_excluded_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_sitemap_excluded_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of sitemap excluded pages issue Get historical occurrences of sitemap excluded pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13699

def sites_site_id_seov2_issues_sitemap_excluded_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/sitemap_excluded_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_sitemap_excluded_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_sitemap_excluded_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_ssl_enabled_details_get(site_id, opts = {}) ⇒ SslEnabledPagesInfo

Get overall stats for ssl enabled issue Get overall stats for ssl enabled issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



13768
13769
13770
13771
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13768

def sites_site_id_seov2_issues_ssl_enabled_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_ssl_enabled_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_ssl_enabled_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(SslEnabledPagesInfo, Integer, Hash)>

Get overall stats for ssl enabled issue Get overall stats for ssl enabled issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(SslEnabledPagesInfo, Integer, Hash)>) —

    SslEnabledPagesInfo data, response status code and response headers



13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13779

def sites_site_id_seov2_issues_ssl_enabled_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/ssl_enabled/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SslEnabledPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_ssl_enabled_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_ssl_enabled_get(site_id, opts = {}) ⇒ SslEnabledPageList

Get ssl enabled issue Get all pages without ssl

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



13838
13839
13840
13841
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13838

def sites_site_id_seov2_issues_ssl_enabled_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_ssl_enabled_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_ssl_enabled_get_with_http_info(site_id, opts = {}) ⇒ Array<(SslEnabledPageList, Integer, Hash)>

Get ssl enabled issue Get all pages without ssl

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(SslEnabledPageList, Integer, Hash)>) —

    SslEnabledPageList data, response status code and response headers



13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13853

def sites_site_id_seov2_issues_ssl_enabled_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/ssl_enabled'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SslEnabledPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_ssl_enabled_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_ssl_enabled_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of ssl enabled issue Get historical occurrences of ssl enabled issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13930
13931
13932
13933
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13930

def sites_site_id_seov2_issues_ssl_enabled_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_ssl_enabled_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_ssl_enabled_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of ssl enabled issue Get historical occurrences of ssl enabled issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 13943

def sites_site_id_seov2_issues_ssl_enabled_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/ssl_enabled/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_ssl_enabled_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_ssl_enabled_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_ssl_mixed_details_get(site_id, opts = {}) ⇒ SslMixedContentPagesInfo

Get overall stats for ssl mixed issue Get overall stats for ssl mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



14012
14013
14014
14015
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14012

def sites_site_id_seov2_issues_ssl_mixed_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_ssl_mixed_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_ssl_mixed_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(SslMixedContentPagesInfo, Integer, Hash)>

Get overall stats for ssl mixed issue Get overall stats for ssl mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(SslMixedContentPagesInfo, Integer, Hash)>) —

    SslMixedContentPagesInfo data, response status code and response headers



14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14023

def sites_site_id_seov2_issues_ssl_mixed_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/ssl_mixed/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SslMixedContentPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_ssl_mixed_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_ssl_mixed_get(site_id, opts = {}) ⇒ SslMixedContentPageList

Get ssl mixed issue Get all pages linking to a http link or pulling in a http resource

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



14082
14083
14084
14085
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14082

def sites_site_id_seov2_issues_ssl_mixed_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_ssl_mixed_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_ssl_mixed_get_with_http_info(site_id, opts = {}) ⇒ Array<(SslMixedContentPageList, Integer, Hash)>

Get ssl mixed issue Get all pages linking to a http link or pulling in a http resource

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(SslMixedContentPageList, Integer, Hash)>) —

    SslMixedContentPageList data, response status code and response headers



14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14097

def sites_site_id_seov2_issues_ssl_mixed_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/ssl_mixed'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SslMixedContentPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_ssl_mixed_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_ssl_mixed_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of ssl mixed issue Get historical occurrences of ssl mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14174
14175
14176
14177
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14174

def sites_site_id_seov2_issues_ssl_mixed_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_ssl_mixed_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_ssl_mixed_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of ssl mixed issue Get historical occurrences of ssl mixed issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14187

def sites_site_id_seov2_issues_ssl_mixed_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/ssl_mixed/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_ssl_mixed_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_ssl_mixed_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code404_details_get(site_id, opts = {}) ⇒ LinksStatusCode404Info

Get overall stats for status code 404 issue Get overall stats for status code 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



14256
14257
14258
14259
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14256

def sites_site_id_seov2_issues_status_code404_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code404_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code404_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinksStatusCode404Info, Integer, Hash)>

Get overall stats for status code 404 issue Get overall stats for status code 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(LinksStatusCode404Info, Integer, Hash)>) —

    LinksStatusCode404Info data, response status code and response headers



14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14267

def sites_site_id_seov2_issues_status_code404_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code404_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_404/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinksStatusCode404Info'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code404_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code404_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code404_get(site_id, opts = {}) ⇒ LinkStatusCode404List

Get status code 404 issue Get all links with status code 404

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



14325
14326
14327
14328
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14325

def sites_site_id_seov2_issues_status_code404_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code404_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code404_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinkStatusCode404List, Integer, Hash)>

Get status code 404 issue Get all links with status code 404

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(LinkStatusCode404List, Integer, Hash)>) —

    LinkStatusCode404List data, response status code and response headers



14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14339

def sites_site_id_seov2_issues_status_code404_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code404_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_404'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinkStatusCode404List'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code404_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code404_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code404_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of status code 404 issue Get historical occurrences of status code 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14411
14412
14413
14414
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14411

def sites_site_id_seov2_issues_status_code404_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code404_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code404_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of status code 404 issue Get historical occurrences of status code 404 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14424

def sites_site_id_seov2_issues_status_code404_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code404_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code404_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_404/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code404_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code404_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code4xxs_details_get(site_id, opts = {}) ⇒ LinksStatusCode4xxInfo

Get overall stats for status code 4xx issue Get overall stats for status code 4xx issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



14493
14494
14495
14496
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14493

def sites_site_id_seov2_issues_status_code4xxs_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code4xxs_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code4xxs_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinksStatusCode4xxInfo, Integer, Hash)>

Get overall stats for status code 4xx issue Get overall stats for status code 4xx issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(LinksStatusCode4xxInfo, Integer, Hash)>) —

    LinksStatusCode4xxInfo data, response status code and response headers



14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14504

def sites_site_id_seov2_issues_status_code4xxs_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_4xxs/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinksStatusCode4xxInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code4xxs_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code4xxs_get(site_id, opts = {}) ⇒ LinkStatusCode4xxList

Get status code 4xx issue Get all links with status code 4xx

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



14562
14563
14564
14565
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14562

def sites_site_id_seov2_issues_status_code4xxs_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code4xxs_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code4xxs_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinkStatusCode4xxList, Integer, Hash)>

Get status code 4xx issue Get all links with status code 4xx

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(LinkStatusCode4xxList, Integer, Hash)>) —

    LinkStatusCode4xxList data, response status code and response headers



14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14576

def sites_site_id_seov2_issues_status_code4xxs_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_4xxs'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinkStatusCode4xxList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code4xxs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code4xxs_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of status code 4xx issue Get historical occurrences of status code 4xx issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14648
14649
14650
14651
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14648

def sites_site_id_seov2_issues_status_code4xxs_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code4xxs_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code4xxs_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of status code 4xx issue Get historical occurrences of status code 4xx issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14661

def sites_site_id_seov2_issues_status_code4xxs_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_4xxs/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code4xxs_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code4xxs_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code500s_details_get(site_id, opts = {}) ⇒ LinksStatusCode500Info

Get overall stats for status code 500 issue Get overall stats for status code 500 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



14730
14731
14732
14733
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14730

def sites_site_id_seov2_issues_status_code500s_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code500s_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code500s_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinksStatusCode500Info, Integer, Hash)>

Get overall stats for status code 500 issue Get overall stats for status code 500 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(LinksStatusCode500Info, Integer, Hash)>) —

    LinksStatusCode500Info data, response status code and response headers



14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14741

def sites_site_id_seov2_issues_status_code500s_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code500s_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_500s/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinksStatusCode500Info'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code500s_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code500s_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code500s_get(site_id, opts = {}) ⇒ LinkStatusCode500List

Get status code 500 issue Get all links with status code 500

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



14799
14800
14801
14802
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14799

def sites_site_id_seov2_issues_status_code500s_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code500s_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code500s_get_with_http_info(site_id, opts = {}) ⇒ Array<(LinkStatusCode500List, Integer, Hash)>

Get status code 500 issue Get all links with status code 500

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(LinkStatusCode500List, Integer, Hash)>) —

    LinkStatusCode500List data, response status code and response headers



14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14813

def sites_site_id_seov2_issues_status_code500s_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code500s_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_500s'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LinkStatusCode500List'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code500s_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code500s_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_status_code500s_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of status code 500 issue Get historical occurrences of status code 500 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14885
14886
14887
14888
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14885

def sites_site_id_seov2_issues_status_code500s_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_status_code500s_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_status_code500s_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of status code 500 issue Get historical occurrences of status code 500 issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14898

def sites_site_id_seov2_issues_status_code500s_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_status_code500s_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_status_code500s_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/status_code_500s/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_status_code500s_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_status_code500s_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_structured_markup_pages_details_get(site_id, opts = {}) ⇒ StructuredDataMarkupPagesInfo

Get overall stats for structured markup pages issue Get overall stats for structured markup pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



14967
14968
14969
14970
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14967

def sites_site_id_seov2_issues_structured_markup_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_structured_markup_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_structured_markup_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(StructuredDataMarkupPagesInfo, Integer, Hash)>

Get overall stats for structured markup pages issue Get overall stats for structured markup pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 14978

def sites_site_id_seov2_issues_structured_markup_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/structured_markup_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StructuredDataMarkupPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_structured_markup_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_structured_markup_pages_get(site_id, opts = {}) ⇒ StructuredDataMarkupPageList

Get structured markup pages issue Get structured markup pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



15037
15038
15039
15040
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15037

def sites_site_id_seov2_issues_structured_markup_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_structured_markup_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_structured_markup_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(StructuredDataMarkupPageList, Integer, Hash)>

Get structured markup pages issue Get structured markup pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15052

def sites_site_id_seov2_issues_structured_markup_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/structured_markup_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StructuredDataMarkupPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_structured_markup_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_structured_markup_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of structured markup pages issue Get historical occurrences of structured markup pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15129
15130
15131
15132
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15129

def sites_site_id_seov2_issues_structured_markup_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_structured_markup_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_structured_markup_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of structured markup pages issue Get historical occurrences of structured markup pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15142

def sites_site_id_seov2_issues_structured_markup_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/structured_markup_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_structured_markup_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_structured_markup_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_touchscreen_ready_details_get(site_id, opts = {}) ⇒ TouchscreenReady

Get touchscreen ready issue Get touchscreen ready issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



15210
15211
15212
15213
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15210

def sites_site_id_seov2_issues_touchscreen_ready_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_touchscreen_ready_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_touchscreen_ready_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(TouchscreenReady, Integer, Hash)>

Get touchscreen ready issue Get touchscreen ready issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TouchscreenReady, Integer, Hash)>) —

    TouchscreenReady data, response status code and response headers



15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15220

def sites_site_id_seov2_issues_touchscreen_ready_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_touchscreen_ready_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_touchscreen_ready_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/touchscreen_ready/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TouchscreenReady'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_touchscreen_ready_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_touchscreen_ready_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_unsafe_domain_details_get(site_id, opts = {}) ⇒ UnsafeDomainSeo

Get unsafe domain issue Get unsafe domain issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



15273
15274
15275
15276
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15273

def sites_site_id_seov2_issues_unsafe_domain_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_unsafe_domain_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_unsafe_domain_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(UnsafeDomainSeo, Integer, Hash)>

Get unsafe domain issue Get unsafe domain issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UnsafeDomainSeo, Integer, Hash)>) —

    UnsafeDomainSeo data, response status code and response headers



15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15283

def sites_site_id_seov2_issues_unsafe_domain_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_unsafe_domain_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_unsafe_domain_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/unsafe_domain/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnsafeDomainSeo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_unsafe_domain_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_unsafe_domain_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_updated_media_details_get(site_id, opts = {}) ⇒ UpdatedMediaInfo

Get overall stats for updated media issue Get overall stats for updated media issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



15337
15338
15339
15340
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15337

def sites_site_id_seov2_issues_updated_media_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_updated_media_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_updated_media_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(UpdatedMediaInfo, Integer, Hash)>

Get overall stats for updated media issue Get overall stats for updated media issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(UpdatedMediaInfo, Integer, Hash)>) —

    UpdatedMediaInfo data, response status code and response headers



15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15348

def sites_site_id_seov2_issues_updated_media_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_updated_media_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/updated_media/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UpdatedMediaInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_updated_media_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_updated_media_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_updated_media_get(site_id, opts = {}) ⇒ NonUpdatedMediaList

Get updated media issue Get all media files not updated within the last year

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



15407
15408
15409
15410
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15407

def sites_site_id_seov2_issues_updated_media_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_updated_media_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_updated_media_get_with_http_info(site_id, opts = {}) ⇒ Array<(NonUpdatedMediaList, Integer, Hash)>

Get updated media issue Get all media files not updated within the last year

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_id (Integer) —

    Id for specific page.

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(NonUpdatedMediaList, Integer, Hash)>) —

    NonUpdatedMediaList data, response status code and response headers



15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15422

def sites_site_id_seov2_issues_updated_media_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_updated_media_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/updated_media'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_id'] = opts[:'page_id'] if !opts[:'page_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NonUpdatedMediaList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_updated_media_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_updated_media_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_updated_media_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of updated media issue Get historical occurrences of updated media issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15495
15496
15497
15498
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15495

def sites_site_id_seov2_issues_updated_media_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_updated_media_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_updated_media_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of updated media issue Get historical occurrences of updated media issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15508

def sites_site_id_seov2_issues_updated_media_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_updated_media_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_media_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/updated_media/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_updated_media_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_updated_media_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_updated_pages_details_get(site_id, opts = {}) ⇒ NonUpdatedPagesInfo

Get overall stats for updated pages issue Get overall stats for updated pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



15577
15578
15579
15580
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15577

def sites_site_id_seov2_issues_updated_pages_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_updated_pages_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_updated_pages_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(NonUpdatedPagesInfo, Integer, Hash)>

Get overall stats for updated pages issue Get overall stats for updated pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(NonUpdatedPagesInfo, Integer, Hash)>) —

    NonUpdatedPagesInfo data, response status code and response headers



15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15588

def sites_site_id_seov2_issues_updated_pages_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_updated_pages_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/updated_pages/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NonUpdatedPagesInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_updated_pages_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_updated_pages_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_updated_pages_get(site_id, opts = {}) ⇒ NonUpdatedPageList

Get updated pages issue Get all pages not updated within the last year

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



15647
15648
15649
15650
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15647

def sites_site_id_seov2_issues_updated_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_updated_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_updated_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(NonUpdatedPageList, Integer, Hash)>

Get updated pages issue Get all pages not updated within the last year

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(NonUpdatedPageList, Integer, Hash)>) —

    NonUpdatedPageList data, response status code and response headers



15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15662

def sites_site_id_seov2_issues_updated_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_updated_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/updated_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NonUpdatedPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_updated_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_updated_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_updated_pages_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of updated pages issue Get historical occurrences of updated pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15739
15740
15741
15742
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15739

def sites_site_id_seov2_issues_updated_pages_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_updated_pages_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_updated_pages_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of updated pages issue Get historical occurrences of updated pages issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15752

def sites_site_id_seov2_issues_updated_pages_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_updated_pages_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_updated_pages_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/updated_pages/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_updated_pages_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_updated_pages_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_urls_with_underscore_details_get(site_id, opts = {}) ⇒ UrlsWithUnderscoreInfo

Get overall stats for urls with underscore issue Get overall stats for urls with underscore issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



15821
15822
15823
15824
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15821

def sites_site_id_seov2_issues_urls_with_underscore_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_urls_with_underscore_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_urls_with_underscore_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(UrlsWithUnderscoreInfo, Integer, Hash)>

Get overall stats for urls with underscore issue Get overall stats for urls with underscore issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(UrlsWithUnderscoreInfo, Integer, Hash)>) —

    UrlsWithUnderscoreInfo data, response status code and response headers



15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15832

def sites_site_id_seov2_issues_urls_with_underscore_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/urls_with_underscore/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UrlsWithUnderscoreInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_urls_with_underscore_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_urls_with_underscore_get(site_id, opts = {}) ⇒ UrlWithUnderscoreList

Get urls with underscore issue Get all pages with an url that has an underscore

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



15891
15892
15893
15894
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15891

def sites_site_id_seov2_issues_urls_with_underscore_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_urls_with_underscore_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_urls_with_underscore_get_with_http_info(site_id, opts = {}) ⇒ Array<(UrlWithUnderscoreList, Integer, Hash)>

Get urls with underscore issue Get all pages with an url that has an underscore

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(UrlWithUnderscoreList, Integer, Hash)>) —

    UrlWithUnderscoreList data, response status code and response headers



15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15906

def sites_site_id_seov2_issues_urls_with_underscore_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/urls_with_underscore'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UrlWithUnderscoreList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_urls_with_underscore_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_urls_with_underscore_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of urls with underscore issue Get historical occurrences of urls with underscore issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15983
15984
15985
15986
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15983

def sites_site_id_seov2_issues_urls_with_underscore_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_urls_with_underscore_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_urls_with_underscore_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of urls with underscore issue Get historical occurrences of urls with underscore issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 15996

def sites_site_id_seov2_issues_urls_with_underscore_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/urls_with_underscore/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_urls_with_underscore_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_urls_with_underscore_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_words_per_page_details_get(site_id, opts = {}) ⇒ WordsPerPageInfo

Get overall stats for words per page issue Get overall stats for words per page issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:



16065
16066
16067
16068
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16065

def sites_site_id_seov2_issues_words_per_page_details_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_words_per_page_details_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_words_per_page_details_get_with_http_info(site_id, opts = {}) ⇒ Array<(WordsPerPageInfo, Integer, Hash)>

Get overall stats for words per page issue Get overall stats for words per page issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

Returns:

  • (Array<(WordsPerPageInfo, Integer, Hash)>) —

    WordsPerPageInfo data, response status code and response headers



16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16076

def sites_site_id_seov2_issues_words_per_page_details_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_words_per_page_details_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_details_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/words_per_page/details'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WordsPerPageInfo'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_words_per_page_details_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_words_per_page_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_words_per_page_get(site_id, opts = {}) ⇒ PageWithLessThan500WordsList

Get words per page issue Get all pages with word count below 500

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



16135
16136
16137
16138
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16135

def sites_site_id_seov2_issues_words_per_page_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_words_per_page_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_words_per_page_get_with_http_info(site_id, opts = {}) ⇒ Array<(PageWithLessThan500WordsList, Integer, Hash)>

Get words per page issue Get all pages with word count below 500

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16150

def sites_site_id_seov2_issues_words_per_page_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_words_per_page_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/words_per_page'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageWithLessThan500WordsList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_words_per_page_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_words_per_page_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_issues_words_per_page_history_get(site_id, opts = {}) ⇒ SeoIssueOccurenceHistoryItemList

Get historical occurrences of words per page issue Get historical occurrences of words per page issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



16227
16228
16229
16230
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16227

def sites_site_id_seov2_issues_words_per_page_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_issues_words_per_page_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_issues_words_per_page_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoIssueOccurenceHistoryItemList, Integer, Hash)>

Get historical occurrences of words per page issue Get historical occurrences of words per page issue

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16240

def sites_site_id_seov2_issues_words_per_page_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_issues_words_per_page_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_issues_words_per_page_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/issues/words_per_page/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueOccurenceHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_issues_words_per_page_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_issues_words_per_page_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_keywords_get(site_id, opts = {}) ⇒ KeywordMonitoringKeywordList

Get monitored keywords Get all monitored keywords

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



16313
16314
16315
16316
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16313

def sites_site_id_seov2_keywords_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_keywords_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_keywords_get_with_http_info(site_id, opts = {}) ⇒ Array<(KeywordMonitoringKeywordList, Integer, Hash)>

Get monitored keywords Get all monitored keywords

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16328

def sites_site_id_seov2_keywords_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_keywords_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_keywords_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_keywords_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_keywords_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_keywords_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/keywords'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'activity_plan_id'] = opts[:'activity_plan_id'] if !opts[:'activity_plan_id'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'KeywordMonitoringKeywordList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_keywords_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_keywords_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_keywords_keyword_id_ranking_pages_get(site_id, keyword_id, opts = {}) ⇒ KeywordRankingList

Get ranking pages for the keyword Get your website’s ranking pages for the keyword

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • keyword_id (Integer) —

    Id for specific keyword

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



16402
16403
16404
16405
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16402

def sites_site_id_seov2_keywords_keyword_id_ranking_pages_get(site_id, keyword_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_keywords_keyword_id_ranking_pages_get_with_http_info(site_id, keyword_id, opts)
  data
end

#sites_site_id_seov2_keywords_keyword_id_ranking_pages_get_with_http_info(site_id, keyword_id, opts = {}) ⇒ Array<(KeywordRankingList, Integer, Hash)>

Get ranking pages for the keyword Get your website&#39;s ranking pages for the keyword

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • keyword_id (Integer) —

    Id for specific keyword

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:

  • (Array<(KeywordRankingList, Integer, Hash)>) —

    KeywordRankingList data, response status code and response headers



16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16416

def sites_site_id_seov2_keywords_keyword_id_ranking_pages_get_with_http_info(site_id, keyword_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get"
  end
  # verify the required parameter 'keyword_id' is set
  if @api_client.config.client_side_validation && keyword_id.nil?
    fail ArgumentError, "Missing the required parameter 'keyword_id' when calling SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/keywords/{keyword_id}/ranking_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'keyword_id' + '}', CGI.escape(keyword_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'activity_plan_id'] = opts[:'activity_plan_id'] if !opts[:'activity_plan_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'KeywordRankingList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_keywords_keyword_id_ranking_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_keywords_keyword_id_ranking_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_overview_groups_get(site_id, opts = {}) ⇒ SeoGroupDetailsList

Get SEO groups Groups are used to display information for specific sections of the website. Only groups that are visible under your profile are returned.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:



16491
16492
16493
16494
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16491

def sites_site_id_seov2_overview_groups_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_overview_groups_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_overview_groups_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoGroupDetailsList, Integer, Hash)>

Get SEO groups Groups are used to display information for specific sections of the website. Only groups that are visible under your profile are returned.

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

Returns:

  • (Array<(SeoGroupDetailsList, Integer, Hash)>) —

    SeoGroupDetailsList data, response status code and response headers



16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16504

def sites_site_id_seov2_overview_groups_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_overview_groups_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_overview_groups_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_overview_groups_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_overview_groups_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_overview_groups_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/overview/groups'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoGroupDetailsList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_overview_groups_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_overview_groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_overview_score_get(site_id, opts = {}) ⇒ SeoScoreDetails

Get the SEO scores Get the top category SEO scores for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page_id (Integer) —

    Id for specific page.

Returns:



16574
16575
16576
16577
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16574

def sites_site_id_seov2_overview_score_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_overview_score_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_overview_score_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoScoreDetails, Integer, Hash)>

Get the SEO scores Get the top category SEO scores for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page_id (Integer) —

    Id for specific page.

Returns:

  • (Array<(SeoScoreDetails, Integer, Hash)>) —

    SeoScoreDetails data, response status code and response headers



16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16586

def sites_site_id_seov2_overview_score_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_overview_score_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_overview_score_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/overview/score'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page_id'] = opts[:'page_id'] if !opts[:'page_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoScoreDetails'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_overview_score_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_overview_score_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_overview_score_history_get(site_id, opts = {}) ⇒ SeoScoreHistoryItemList

Get the SEO scores historically Get the top category SEO scores historically for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:



16645
16646
16647
16648
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16645

def sites_site_id_seov2_overview_score_history_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_overview_score_history_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_overview_score_history_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoScoreHistoryItemList, Integer, Hash)>

Get the SEO scores historically Get the top category SEO scores historically for your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :period (String) —

    Period for which to retrieve data. Default is last 7 days. A period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only. A single date YYYYMMDD will return data for that day. A range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included. A predefined interval can be one of the following (case insensitive): now today yesterday last_seven_days last_week last_month this_month this_year

Returns:

  • (Array<(SeoScoreHistoryItemList, Integer, Hash)>) —

    SeoScoreHistoryItemList data, response status code and response headers



16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16659

def sites_site_id_seov2_overview_score_history_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_overview_score_history_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_overview_score_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_overview_score_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_overview_score_history_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_overview_score_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/overview/score/history'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoScoreHistoryItemList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_overview_score_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_overview_score_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_pages_get(site_id, opts = {}) ⇒ SeoRecommendationPageList

Get pages with issues Get all pages found on your website with issues

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



16734
16735
16736
16737
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16734

def sites_site_id_seov2_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoRecommendationPageList, Integer, Hash)>

Get pages with issues Get all pages found on your website with issues

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:

  • (Array<(SeoRecommendationPageList, Integer, Hash)>) —

    SeoRecommendationPageList data, response status code and response headers



16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16750

def sites_site_id_seov2_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoRecommendationPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_pages_page_id_issues_get(site_id, page_id, opts = {}) ⇒ SeoIssueWithRecommendationList

Get issues for specific page Get the SEO issues found for the specific page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String) —

    The category filter (default to ‘none’)

  • :complexity (String) —

    The complexity filter (default to ‘none’)

  • :fixed (Boolean) —

    The fixed filter

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



16832
16833
16834
16835
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16832

def sites_site_id_seov2_pages_page_id_issues_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_pages_page_id_issues_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_seov2_pages_page_id_issues_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(SeoIssueWithRecommendationList, Integer, Hash)>

Get issues for specific page Get the SEO issues found for the specific page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String) —

    The category filter (default to ‘none’)

  • :complexity (String) —

    The complexity filter (default to ‘none’)

  • :fixed (Boolean) —

    The fixed filter

  • :group_id (Integer) —

    Id for specific group.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16849

def sites_site_id_seov2_pages_page_id_issues_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get"
  end
  allowable_values = ["none", "technical", "content", "ux", "mobile"]
  if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
    fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
  end
  allowable_values = ["none", "low", "medium", "high", "extreme"]
  if @api_client.config.client_side_validation && opts[:'complexity'] && !allowable_values.include?(opts[:'complexity'])
    fail ArgumentError, "invalid value for \"complexity\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/pages/{page_id}/issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'complexity'] = opts[:'complexity'] if !opts[:'complexity'].nil?
  query_params[:'fixed'] = opts[:'fixed'] if !opts[:'fixed'].nil?
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoIssueWithRecommendationList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_pages_page_id_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_pages_page_id_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_get(site_id, opts = {}) ⇒ SeoRecommendationTargetPageList

Get target pages for keywords Get target pages for keywords on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



16938
16939
16940
16941
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16938

def sites_site_id_seov2_target_pages_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_target_pages_get_with_http_info(site_id, opts = {}) ⇒ Array<(SeoRecommendationTargetPageList, Integer, Hash)>

Get target pages for keywords Get target pages for keywords on your website

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :group_id (Integer) —

    Id for specific group.

  • :ids (Array<Integer>) —

    Return all items that is one of the listed identifiers. Values are separated by comma, as in ids&#x3D;1,2,3.

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

  • :query (String) —

    Return all items that matches the specified plain text query.

  • :search_in (String) —

    Specified query must match either url or title. (default to ‘url’)

Returns:



16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 16954

def sites_site_id_seov2_target_pages_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_get, must be greater than or equal to 1.'
  end

  allowable_values = ["url", "title"]
  if @api_client.config.client_side_validation && opts[:'search_in'] && !allowable_values.include?(opts[:'search_in'])
    fail ArgumentError, "invalid value for \"search_in\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'search_in'] = opts[:'search_in'] if !opts[:'search_in'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeoRecommendationTargetPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get(site_id, page_id, opts = {}) ⇒ ContentOptimizationTargetUrlCompetingContentList

Get competing content issues for the target page Get competing content issues for the target page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17032
17033
17034
17035
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17032

def sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(ContentOptimizationTargetUrlCompetingContentList, Integer, Hash)>

Get competing content issues for the target page Get competing content issues for the target page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17045

def sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages/pages/{page_id}/competing_content_issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationTargetUrlCompetingContentList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get(site_id, page_id, type, opts = {}) ⇒ ContentOptimizationTargetUrlCompetingContentPageList

Get the competing content issue type for the page Get the competing content issue type for the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • type (String) —

    The competing content type

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :keyword (String) —

    The keyword

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17121
17122
17123
17124
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17121

def sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get(site_id, page_id, type, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get_with_http_info(site_id, page_id, type, opts)
  data
end

#sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get_with_http_info(site_id, page_id, type, opts = {}) ⇒ Array<(ContentOptimizationTargetUrlCompetingContentPageList, Integer, Hash)>

Get the competing content issue type for the page Get the competing content issue type for the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • type (String) —

    The competing content type

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :keyword (String) —

    The keyword

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17136

def sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get_with_http_info(site_id, page_id, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get"
  end
  # verify enum value
  allowable_values = ["h1", "h2", "h3", "title", "meta_description"]
  if @api_client.config.client_side_validation && !allowable_values.include?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages/pages/{page_id}/competing_content_issues/{type}/pages'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s)).sub('{' + 'type' + '}', CGI.escape(type.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'keyword'] = opts[:'keyword'] if !opts[:'keyword'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationTargetUrlCompetingContentPageList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_pages_page_id_competing_content_issues_type_pages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get(site_id, page_id, opts = {}) ⇒ ContentOptimizationTargetUrlKeywordIssueList

Get keyword issues for the page Get keyword issues for the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17220
17221
17222
17223
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17220

def sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(ContentOptimizationTargetUrlKeywordIssueList, Integer, Hash)>

Get keyword issues for the page Get keyword issues for the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17233

def sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages/pages/{page_id}/keyword_issues'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationTargetUrlKeywordIssueList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_pages_page_id_keyword_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get(site_id, page_id, opts = {}) ⇒ ContentOptimizationTargetUrlOptimizationList

Get keyword occurrences for the page Get keyword occurrences for the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17307
17308
17309
17310
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17307

def sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(ContentOptimizationTargetUrlOptimizationList, Integer, Hash)>

Get keyword occurrences for the page Get keyword occurrences for the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17320

def sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages/pages/{page_id}/keyword_occurrences'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationTargetUrlOptimizationList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_pages_page_id_keyword_occurrences_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_pages_page_id_keywords_get(site_id, page_id, opts = {}) ⇒ ContentOptimizationTargetUrlKeywordList

Get the keywords targeting the page Get the keywords targeting the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17394
17395
17396
17397
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17394

def sites_site_id_seov2_target_pages_pages_page_id_keywords_get(site_id, page_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_pages_page_id_keywords_get_with_http_info(site_id, page_id, opts)
  data
end

#sites_site_id_seov2_target_pages_pages_page_id_keywords_get_with_http_info(site_id, page_id, opts = {}) ⇒ Array<(ContentOptimizationTargetUrlKeywordList, Integer, Hash)>

Get the keywords targeting the page Get the keywords targeting the page

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • page_id (Integer) —

    Id for specific page.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number to show when more than one page in paged output. (default to 1)

  • :page_size (Integer) —

    Number of items/records per page in paged output. (default to 10)

Returns:



17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17407

def sites_site_id_seov2_target_pages_pages_page_id_keywords_get_with_http_info(site_id, page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get"
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages/pages/{page_id}/keywords'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s)).sub('{' + 'page_id' + '}', CGI.escape(page_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ContentOptimizationTargetUrlKeywordList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_pages_page_id_keywords_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_pages_page_id_keywords_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sites_site_id_seov2_target_pages_summary_get(site_id, opts = {}) ⇒ TargetPagesIssuesHighlights

Get overall statistics for target pages Get overall statistics for target pages

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

Returns:



17479
17480
17481
17482
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17479

def sites_site_id_seov2_target_pages_summary_get(site_id, opts = {})
  data, _status_code, _headers = sites_site_id_seov2_target_pages_summary_get_with_http_info(site_id, opts)
  data
end

#sites_site_id_seov2_target_pages_summary_get_with_http_info(site_id, opts = {}) ⇒ Array<(TargetPagesIssuesHighlights, Integer, Hash)>

Get overall statistics for target pages Get overall statistics for target pages

Parameters:

  • site_id (Integer) —

    Id for specific site.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :activity_plan_id (Integer) —

    Id for specific activity plan

Returns:

  • (Array<(TargetPagesIssuesHighlights, Integer, Hash)>) —

    TargetPagesIssuesHighlights data, response status code and response headers



17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
 
# File 'lib/siteimprove_api_client/api/seo_v2_api.rb', line 17490

def sites_site_id_seov2_target_pages_summary_get_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeoV2Api.sites_site_id_seov2_target_pages_summary_get ...'
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling SeoV2Api.sites_site_id_seov2_target_pages_summary_get"
  end
  # resource path
  local_var_path = '/sites/{site_id}/seov2/target_pages/summary'.sub('{' + 'site_id' + '}', CGI.escape(site_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'activity_plan_id'] = opts[:'activity_plan_id'] if !opts[:'activity_plan_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TargetPagesIssuesHighlights'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic_auth']

  new_options = opts.merge(
    :operation => :"SeoV2Api.sites_site_id_seov2_target_pages_summary_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeoV2Api#sites_site_id_seov2_target_pages_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end